Whamcloud - gitweb
LU-14139 statahead: add stats for batch RPC requests
[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                         timer_delete(&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",
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 EXPORT_SYMBOL(ldlm_server_completion_ast);
1170
1171 /**
1172  * Server side ->l_glimpse_ast handler for client locks.
1173  *
1174  * Sends glimpse AST to the client and waits for reply. Then updates
1175  * lvbo with the result.
1176  */
1177 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data)
1178 {
1179         struct ldlm_cb_set_arg *arg = data;
1180         struct ldlm_request *body;
1181         struct ptlrpc_request *req;
1182         struct ldlm_cb_async_args *ca;
1183         int rc;
1184         struct req_format *req_fmt;
1185
1186         ENTRY;
1187
1188         LASSERT(lock != NULL);
1189
1190         if (arg->gl_desc != NULL)
1191                 /* There is a glimpse descriptor to pack */
1192                 req_fmt = &RQF_LDLM_GL_CALLBACK_DESC;
1193         else
1194                 req_fmt = &RQF_LDLM_GL_CALLBACK;
1195
1196         req = ptlrpc_request_alloc_pack(lock->l_export->exp_imp_reverse,
1197                                         req_fmt, LUSTRE_DLM_VERSION,
1198                                         LDLM_GL_CALLBACK);
1199
1200         if (req == NULL)
1201                 RETURN(-ENOMEM);
1202
1203         if (arg->gl_desc != NULL) {
1204                 /* copy the GL descriptor */
1205                 union ldlm_gl_desc      *desc;
1206
1207                 desc = req_capsule_client_get(&req->rq_pill, &RMF_DLM_GL_DESC);
1208                 *desc = *arg->gl_desc;
1209         }
1210
1211         body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1212         body->lock_handle[0] = lock->l_remote_handle;
1213         ldlm_lock2desc(lock, &body->lock_desc);
1214
1215         ca = ptlrpc_req_async_args(ca, req);
1216         ca->ca_set_arg = arg;
1217         ca->ca_lock = lock;
1218
1219         /* server namespace, doesn't need lock */
1220         req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
1221                              ldlm_lvbo_size(lock));
1222         ptlrpc_request_set_replen(req);
1223
1224         req->rq_send_state = LUSTRE_IMP_FULL;
1225         /* ptlrpc_request_alloc_pack already set timeout */
1226         if (AT_OFF)
1227                 req->rq_timeout = ldlm_get_rq_timeout();
1228
1229         req->rq_interpret_reply = ldlm_cb_interpret;
1230
1231         if (lock->l_export && lock->l_export->exp_nid_stats) {
1232                 struct nid_stat *nid_stats = lock->l_export->exp_nid_stats;
1233
1234                 lprocfs_counter_incr(nid_stats->nid_ldlm_stats,
1235                                      LDLM_GL_CALLBACK - LDLM_FIRST_OPC);
1236         }
1237
1238         rc = ldlm_ast_fini(req, arg, lock, 0);
1239
1240         RETURN(rc);
1241 }
1242 EXPORT_SYMBOL(ldlm_server_glimpse_ast);
1243
1244 int ldlm_glimpse_locks(struct ldlm_resource *res,
1245                        struct list_head *gl_work_list)
1246 {
1247         int rc;
1248
1249         ENTRY;
1250
1251         rc = ldlm_run_ast_work(ldlm_res_to_ns(res), gl_work_list,
1252                                LDLM_WORK_GL_AST);
1253         if (rc == -ERESTART)
1254                 ldlm_reprocess_all(res, 0);
1255
1256         RETURN(rc);
1257 }
1258 EXPORT_SYMBOL(ldlm_glimpse_locks);
1259
1260 /* return LDLM lock associated with a lock callback request */
1261 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req)
1262 {
1263         struct ldlm_cb_async_args *ca;
1264         struct ldlm_lock *lock;
1265
1266         ENTRY;
1267
1268         ca = ptlrpc_req_async_args(ca, req);
1269         lock = ca->ca_lock;
1270         if (lock == NULL)
1271                 RETURN(ERR_PTR(-EFAULT));
1272
1273         RETURN(lock);
1274 }
1275 EXPORT_SYMBOL(ldlm_request_lock);
1276
1277 /**
1278  * Main server-side entry point into LDLM for enqueue. This is called by ptlrpc
1279  * service threads to carry out client lock enqueueing requests.
1280  */
1281 int ldlm_handle_enqueue(struct ldlm_namespace *ns,
1282                         struct req_capsule *pill,
1283                         const struct ldlm_request *dlm_req,
1284                         const struct ldlm_callback_suite *cbs)
1285 {
1286         struct ldlm_reply *dlm_rep;
1287         __u64 flags;
1288         enum ldlm_error err = ELDLM_OK;
1289         struct ldlm_lock *lock = NULL;
1290         void *cookie = NULL;
1291         int rc = 0;
1292         struct ldlm_resource *res = NULL;
1293         struct ptlrpc_request *req = pill->rc_req;
1294         const struct lu_env *env = req->rq_svc_thread->t_env;
1295
1296         ENTRY;
1297
1298         LDLM_DEBUG_NOLOCK("server-side enqueue handler START");
1299
1300         LASSERT(req && req->rq_export);
1301
1302         if (req_capsule_ptlreq(pill))
1303                 ldlm_request_cancel(req, dlm_req, LDLM_ENQUEUE_CANCEL_OFF,
1304                                     LATF_SKIP);
1305
1306         flags = ldlm_flags_from_wire(dlm_req->lock_flags);
1307
1308         /* for intent enqueue the stat will be updated inside intent policy */
1309         if (ptlrpc_req2svc(req)->srv_stats != NULL &&
1310             !(dlm_req->lock_flags & LDLM_FL_HAS_INTENT))
1311                 ldlm_svc_get_eopc(dlm_req, ptlrpc_req2svc(req)->srv_stats);
1312
1313         if (req->rq_export->exp_nid_stats &&
1314             req->rq_export->exp_nid_stats->nid_ldlm_stats)
1315                 lprocfs_counter_incr(req->rq_export->exp_nid_stats->nid_ldlm_stats,
1316                                      LDLM_ENQUEUE - LDLM_FIRST_OPC);
1317
1318         if (unlikely(dlm_req->lock_desc.l_resource.lr_type < LDLM_MIN_TYPE ||
1319                      dlm_req->lock_desc.l_resource.lr_type >= LDLM_MAX_TYPE)) {
1320                 DEBUG_REQ(D_ERROR, req, "invalid lock request type %d",
1321                           dlm_req->lock_desc.l_resource.lr_type);
1322                 GOTO(out, rc = -EFAULT);
1323         }
1324
1325         if (unlikely(dlm_req->lock_desc.l_req_mode <= LCK_MINMODE ||
1326                      dlm_req->lock_desc.l_req_mode >= LCK_MAXMODE ||
1327                      dlm_req->lock_desc.l_req_mode &
1328                      (dlm_req->lock_desc.l_req_mode-1))) {
1329                 DEBUG_REQ(D_ERROR, req, "invalid lock request mode %d",
1330                           dlm_req->lock_desc.l_req_mode);
1331                 GOTO(out, rc = -EFAULT);
1332         }
1333
1334         if (unlikely((flags & LDLM_FL_REPLAY) ||
1335                      (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT))) {
1336                 /* Find an existing lock in the per-export lock hash */
1337                 /*
1338                  * In the function below, .hs_keycmp resolves to
1339                  * ldlm_export_lock_keycmp()
1340                  */
1341                 /* coverity[overrun-buffer-val] */
1342                 lock = cfs_hash_lookup(req->rq_export->exp_lock_hash,
1343                                        (void *)&dlm_req->lock_handle[0]);
1344                 if (lock != NULL) {
1345                         DEBUG_REQ(D_DLMTRACE, req,
1346                                   "found existing lock cookie %#llx",
1347                                   lock->l_handle.h_cookie);
1348                         flags |= LDLM_FL_RESENT;
1349                         GOTO(existing_lock, rc = 0);
1350                 }
1351         } else {
1352                 if (ldlm_reclaim_full()) {
1353                         DEBUG_REQ(D_DLMTRACE, req,
1354                                   "Too many granted locks, reject current enqueue request and let the client retry later");
1355                         GOTO(out, rc = -EINPROGRESS);
1356                 }
1357         }
1358
1359         /* The lock's callback data might be set in the policy function */
1360         lock = ldlm_lock_create(ns, &dlm_req->lock_desc.l_resource.lr_name,
1361                                 dlm_req->lock_desc.l_resource.lr_type,
1362                                 dlm_req->lock_desc.l_req_mode,
1363                                 cbs, NULL, 0, LVB_T_NONE);
1364         if (IS_ERR(lock)) {
1365                 rc = PTR_ERR(lock);
1366                 lock = NULL;
1367                 GOTO(out, rc);
1368         }
1369
1370         lock->l_remote_handle = dlm_req->lock_handle[0];
1371         LDLM_DEBUG(lock, "server-side enqueue handler, new lock created");
1372
1373         /*
1374          * Initialize resource lvb but not for a lock being replayed since
1375          * Client already got lvb sent in this case.
1376          * This must occur early since some policy methods assume resource
1377          * lvb is available (lr_lvb_data != NULL).
1378          */
1379         res = lock->l_resource;
1380         if (!(flags & LDLM_FL_REPLAY)) {
1381                 /* non-replayed lock, delayed lvb init may need to be done */
1382                 rc = ldlm_lvbo_init(res);
1383                 if (rc < 0) {
1384                         LDLM_DEBUG(lock, "delayed lvb init failed (rc %d)", rc);
1385                         GOTO(out, rc);
1386                 }
1387         }
1388
1389         OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_ENQUEUE_BLOCKED, obd_timeout * 2);
1390         /*
1391          * Don't enqueue a lock onto the export if it is been disonnected
1392          * due to eviction (b=3822) or server umount (b=24324).
1393          * Cancel it now instead.
1394          */
1395         if (req->rq_export->exp_disconnected) {
1396                 LDLM_ERROR(lock, "lock on disconnected export %p",
1397                            req->rq_export);
1398                 GOTO(out, rc = -ENOTCONN);
1399         }
1400
1401         lock->l_export = class_export_lock_get(req->rq_export, lock);
1402         if (lock->l_export->exp_lock_hash)
1403                 cfs_hash_add(lock->l_export->exp_lock_hash,
1404                              &lock->l_remote_handle,
1405                              &lock->l_exp_hash);
1406
1407         /*
1408          * Inherit the enqueue flags before the operation, because we do not
1409          * keep the res lock on return and next operations (BL AST) may proceed
1410          * without them.
1411          */
1412         lock->l_flags |= ldlm_flags_from_wire(dlm_req->lock_flags &
1413                                               LDLM_FL_INHERIT_MASK);
1414
1415         ldlm_convert_policy_to_local(req->rq_export,
1416                                      dlm_req->lock_desc.l_resource.lr_type,
1417                                      &dlm_req->lock_desc.l_policy_data,
1418                                      &lock->l_policy_data);
1419         if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT) {
1420                 lock->l_req_extent = lock->l_policy_data.l_extent;
1421         } else if (dlm_req->lock_desc.l_resource.lr_type == LDLM_IBITS) {
1422                 lock->l_policy_data.l_inodebits.try_bits =
1423                         dlm_req->lock_desc.l_policy_data.l_inodebits.try_bits;
1424                 lock->l_policy_data.l_inodebits.li_gid =
1425                         dlm_req->lock_desc.l_policy_data.l_inodebits.li_gid;
1426         }
1427
1428 existing_lock:
1429         cookie = req;
1430         if (!(flags & LDLM_FL_HAS_INTENT)) {
1431                 /* based on the assumption that lvb size never changes during
1432                  * resource life time otherwise it need resource->lr_lock's
1433                  * protection */
1434                 req_capsule_set_size(pill, &RMF_DLM_LVB,
1435                                      RCL_SERVER, ldlm_lvbo_size(lock));
1436
1437                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR))
1438                         GOTO(out, rc = -ENOMEM);
1439
1440                 rc = req_capsule_server_pack(pill);
1441                 if (rc)
1442                         GOTO(out, rc);
1443         }
1444
1445         err = ldlm_lock_enqueue(env, ns, &lock, cookie, &flags);
1446         if (err) {
1447                 if ((int)err < 0)
1448                         rc = (int)err;
1449                 GOTO(out, err);
1450         }
1451
1452         dlm_rep = req_capsule_server_get(pill, &RMF_DLM_REP);
1453
1454         ldlm_lock2desc(lock, &dlm_rep->lock_desc);
1455         ldlm_lock2handle(lock, &dlm_rep->lock_handle);
1456
1457         if (lock->l_resource->lr_type == LDLM_EXTENT)
1458                 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_BL_EVICT, 6);
1459
1460         /*
1461          * We never send a blocking AST until the lock is granted, but
1462          * we can tell it right now
1463          */
1464         lock_res_and_lock(lock);
1465
1466         /*
1467          * Now take into account flags to be inherited from original lock
1468          * request both in reply to client and in our own lock flags.
1469          */
1470         dlm_rep->lock_flags = ldlm_flags_to_wire(flags);
1471         lock->l_flags |= flags & LDLM_FL_INHERIT_MASK;
1472
1473         /*
1474          * Don't move a pending lock onto the export if it has already been
1475          * disconnected due to eviction (b=5683) or server umount (b=24324).
1476          * Cancel it now instead.
1477          */
1478         if (unlikely(req->rq_export->exp_disconnected ||
1479                      OBD_FAIL_CHECK(OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT))) {
1480                 LDLM_ERROR(lock, "lock on destroyed export %p", req->rq_export);
1481                 rc = -ENOTCONN;
1482         } else if (ldlm_is_ast_sent(lock)) {
1483                 /* fill lock desc for possible lock convert */
1484                 if (lock->l_blocking_lock &&
1485                     lock->l_resource->lr_type == LDLM_IBITS) {
1486                         struct ldlm_lock *bl_lock = lock->l_blocking_lock;
1487                         struct ldlm_lock_desc *rep_desc = &dlm_rep->lock_desc;
1488
1489                         LDLM_DEBUG(lock,
1490                                    "save blocking bits %llx in granted lock",
1491                                    bl_lock->l_policy_data.l_inodebits.bits);
1492                         /*
1493                          * If lock is blocked then save blocking ibits
1494                          * in returned lock policy for the possible lock
1495                          * convert on a client.
1496                          */
1497                         rep_desc->l_policy_data.l_inodebits.cancel_bits =
1498                                 bl_lock->l_policy_data.l_inodebits.bits;
1499                 }
1500                 dlm_rep->lock_flags |= ldlm_flags_to_wire(LDLM_FL_AST_SENT);
1501                 if (ldlm_is_granted(lock)) {
1502                         /*
1503                          * Only cancel lock if it was granted, because it would
1504                          * be destroyed immediately and would never be granted
1505                          * in the future, causing timeouts on client.  Not
1506                          * granted lock will be cancelled immediately after
1507                          * sending completion AST.
1508                          */
1509                         if (ldlm_is_cancel_on_block(lock)) {
1510                                 unlock_res_and_lock(lock);
1511                                 ldlm_lock_cancel(lock);
1512                                 lock_res_and_lock(lock);
1513                         } else {
1514                                 ldlm_add_waiting_lock(lock,
1515                                                       ldlm_bl_timeout(lock));
1516                         }
1517                 }
1518         }
1519         unlock_res_and_lock(lock);
1520
1521         EXIT;
1522 out:
1523         if (req_capsule_ptlreq(pill)) {
1524                 req->rq_status = rc ?: err; /* return either error - b=11190 */
1525                 if (!req->rq_packed_final) {
1526                         int rc1 = lustre_pack_reply(req, 1, NULL, NULL);
1527                         if (rc == 0)
1528                                 rc = rc1;
1529                 }
1530         }
1531
1532         /*
1533          * The LOCK_CHANGED code in ldlm_lock_enqueue depends on this
1534          * ldlm_reprocess_all.  If this moves, revisit that code. -phil
1535          */
1536         if (lock != NULL) {
1537                 LDLM_DEBUG(lock,
1538                            "server-side enqueue handler, sending reply (err=%d, rc=%d)",
1539                            err, rc);
1540
1541                 if (rc == 0 &&
1542                     req_capsule_has_field(pill, &RMF_DLM_LVB,
1543                                           RCL_SERVER) &&
1544                     ldlm_lvbo_size(lock) > 0) {
1545                         void *buf;
1546                         int buflen;
1547
1548 retry:
1549                         buf = req_capsule_server_get(pill, &RMF_DLM_LVB);
1550                         LASSERTF(buf != NULL, "req %p, lock %p\n", req, lock);
1551                         buflen = req_capsule_get_size(pill, &RMF_DLM_LVB,
1552                                                       RCL_SERVER);
1553                         /*
1554                          * non-replayed lock, delayed lvb init may
1555                          * need to be occur now
1556                          */
1557                         if ((buflen > 0) && !(flags & LDLM_FL_REPLAY)) {
1558                                 int rc2;
1559
1560                                 rc2 = ldlm_lvbo_fill(lock, buf, &buflen);
1561                                 if (rc2 >= 0) {
1562                                         req_capsule_shrink(pill, &RMF_DLM_LVB,
1563                                                            rc2, RCL_SERVER);
1564                                 } else if (rc2 == -ERANGE) {
1565                                         rc2 = req_capsule_server_grow(
1566                                                         pill, &RMF_DLM_LVB,
1567                                                         buflen);
1568                                         if (!rc2) {
1569                                                 goto retry;
1570                                         } else {
1571                                                 /*
1572                                                  * if we can't grow the buffer,
1573                                                  * it's ok to return empty lvb
1574                                                  * to client.
1575                                                  */
1576                                                 req_capsule_shrink(
1577                                                         pill, &RMF_DLM_LVB, 0,
1578                                                         RCL_SERVER);
1579                                         }
1580                                 } else {
1581                                         rc = rc2;
1582                                 }
1583                         } else if (flags & LDLM_FL_REPLAY) {
1584                                 /* no LVB resend upon replay */
1585                                 if (buflen > 0)
1586                                         req_capsule_shrink(pill, &RMF_DLM_LVB,
1587                                                            0, RCL_SERVER);
1588                                 else
1589                                         rc = buflen;
1590                         } else {
1591                                 rc = buflen;
1592                         }
1593                 }
1594
1595                 if (rc != 0 && !(flags & LDLM_FL_RESENT)) {
1596                         if (lock->l_export) {
1597                                 ldlm_lock_cancel(lock);
1598                         } else {
1599                                 lock_res_and_lock(lock);
1600                                 ldlm_resource_unlink_lock(lock);
1601                                 ldlm_lock_destroy_nolock(lock);
1602                                 unlock_res_and_lock(lock);
1603                         }
1604                         ldlm_reprocess_all(lock->l_resource, lock->l_policy_data.l_inodebits.bits);
1605                 }
1606
1607                 if (!err && !ldlm_is_cbpending(lock) &&
1608                     dlm_req->lock_desc.l_resource.lr_type != LDLM_FLOCK)
1609                         ldlm_reprocess_all(lock->l_resource,
1610                                            lock->l_policy_data.l_inodebits.bits);
1611
1612                 LDLM_LOCK_RELEASE(lock);
1613         }
1614
1615         LDLM_DEBUG_NOLOCK("server-side enqueue handler END (lock %p, rc %d)",
1616                           lock, rc);
1617
1618         return rc;
1619 }
1620 EXPORT_SYMBOL(ldlm_handle_enqueue);
1621
1622 /*
1623  * Clear the blocking lock, the race is possible between ldlm_handle_convert0()
1624  * and ldlm_work_bl_ast_lock(), so this is done under lock with check for NULL.
1625  */
1626 void ldlm_clear_blocking_lock(struct ldlm_lock *lock)
1627 {
1628         if (lock->l_blocking_lock) {
1629                 LDLM_LOCK_RELEASE(lock->l_blocking_lock);
1630                 lock->l_blocking_lock = NULL;
1631         }
1632 }
1633
1634 /* A lock can be converted to new ibits or mode and should be considered
1635  * as new lock. Clear all states related to a previous blocking AST
1636  * processing so new conflicts will cause new blocking ASTs.
1637  *
1638  * This is used during lock convert below and lock downgrade to COS mode in
1639  * ldlm_lock_mode_downgrade().
1640  */
1641 void ldlm_clear_blocking_data(struct ldlm_lock *lock)
1642 {
1643         ldlm_clear_ast_sent(lock);
1644         lock->l_bl_ast_run = 0;
1645         ldlm_clear_blocking_lock(lock);
1646 }
1647
1648 /**
1649  * Main LDLM entry point for server code to process lock conversion requests.
1650  */
1651 int ldlm_handle_convert0(struct ptlrpc_request *req,
1652                          const struct ldlm_request *dlm_req)
1653 {
1654         struct obd_export *exp = req->rq_export;
1655         struct ldlm_reply *dlm_rep;
1656         struct ldlm_lock *lock;
1657         __u64 bits;
1658         __u64 new_bits;
1659         int rc;
1660
1661         ENTRY;
1662
1663         if (exp && exp->exp_nid_stats && exp->exp_nid_stats->nid_ldlm_stats)
1664                 lprocfs_counter_incr(exp->exp_nid_stats->nid_ldlm_stats,
1665                                      LDLM_CONVERT - LDLM_FIRST_OPC);
1666
1667         rc = req_capsule_server_pack(&req->rq_pill);
1668         if (rc)
1669                 RETURN(rc);
1670
1671         dlm_rep = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
1672         dlm_rep->lock_flags = dlm_req->lock_flags;
1673
1674         lock = ldlm_handle2lock(&dlm_req->lock_handle[0]);
1675         if (!lock) {
1676                 LDLM_DEBUG_NOLOCK("server lock is canceled already");
1677                 req->rq_status = ELDLM_NO_LOCK_DATA;
1678                 RETURN(0);
1679         }
1680
1681         LDLM_DEBUG(lock, "server-side convert handler START");
1682
1683         lock_res_and_lock(lock);
1684         bits = lock->l_policy_data.l_inodebits.bits;
1685         new_bits = dlm_req->lock_desc.l_policy_data.l_inodebits.bits;
1686
1687         if (ldlm_is_cancel(lock)) {
1688                 LDLM_DEBUG(lock, "convert on canceled lock!");
1689                 unlock_res_and_lock(lock);
1690                 GOTO(out_put, rc = ELDLM_NO_LOCK_DATA);
1691         }
1692
1693         if (dlm_req->lock_desc.l_req_mode != lock->l_granted_mode) {
1694                 LDLM_ERROR(lock, "lock mode differs!");
1695                 unlock_res_and_lock(lock);
1696                 GOTO(out_put, rc = -EPROTO);
1697         }
1698
1699         if (bits == new_bits) {
1700                 /*
1701                  * This can be valid situation if CONVERT RPCs are
1702                  * re-ordered. Just finish silently
1703                  */
1704                 LDLM_DEBUG(lock, "lock is converted already!");
1705                 unlock_res_and_lock(lock);
1706         } else {
1707                 if (ldlm_is_waited(lock))
1708                         ldlm_del_waiting_lock(lock);
1709
1710                 ldlm_clear_cbpending(lock);
1711                 lock->l_policy_data.l_inodebits.cancel_bits = 0;
1712                 ldlm_inodebits_drop(lock, bits & ~new_bits);
1713
1714                 ldlm_clear_blocking_data(lock);
1715                 unlock_res_and_lock(lock);
1716
1717                 /* All old bits should be reprocessed to send new BL AST if
1718                  * it wasn't sent earlier due to LDLM_FL_AST_SENT bit set.
1719                  * */
1720                 ldlm_reprocess_all(lock->l_resource, bits);
1721         }
1722
1723         dlm_rep->lock_handle = lock->l_remote_handle;
1724         ldlm_ibits_policy_local_to_wire(&lock->l_policy_data,
1725                                         &dlm_rep->lock_desc.l_policy_data);
1726         rc = ELDLM_OK;
1727         EXIT;
1728 out_put:
1729         LDLM_DEBUG(lock, "server-side convert handler END, rc = %d", rc);
1730         LDLM_LOCK_PUT(lock);
1731         req->rq_status = rc;
1732         return 0;
1733 }
1734
1735 /**
1736  * Cancel all the locks whose handles are packed into ldlm_request
1737  *
1738  * Called by server code expecting such combined cancel activity
1739  * requests.
1740  */
1741 int ldlm_request_cancel(struct ptlrpc_request *req,
1742                         const struct ldlm_request *dlm_req,
1743                         int first, enum lustre_at_flags flags)
1744 {
1745         struct ldlm_resource *res, *pres = NULL;
1746         struct ldlm_lock *lock;
1747         int i, count, done = 0;
1748         unsigned int size;
1749
1750         ENTRY;
1751
1752         size = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT);
1753         if (size <= offsetof(struct ldlm_request, lock_handle) ||
1754             (size - offsetof(struct ldlm_request, lock_handle)) /
1755              sizeof(struct lustre_handle) < dlm_req->lock_count)
1756                 RETURN(0);
1757
1758         count = dlm_req->lock_count ? dlm_req->lock_count : 1;
1759         if (first >= count)
1760                 RETURN(0);
1761
1762         if (count == 1 && dlm_req->lock_handle[0].cookie == 0)
1763                 RETURN(0);
1764
1765         /*
1766          * There is no lock on the server at the replay time,
1767          * skip lock cancelling to make replay tests to pass.
1768          */
1769         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
1770                 RETURN(0);
1771
1772         LDLM_DEBUG_NOLOCK("server-side cancel handler START: %d locks, starting at %d",
1773                           count, first);
1774
1775         for (i = first; i < count; i++) {
1776                 lock = ldlm_handle2lock(&dlm_req->lock_handle[i]);
1777                 if (!lock) {
1778                         /* below message checked in replay-single.sh test_36 */
1779                         LDLM_DEBUG_NOLOCK("server-side cancel handler stale lock (cookie %llu)",
1780                                           dlm_req->lock_handle[i].cookie);
1781                         continue;
1782                 }
1783
1784                 res = lock->l_resource;
1785                 done++;
1786
1787                 /*
1788                  * This code is an optimization to only attempt lock
1789                  * granting on the resource (that could be CPU-expensive)
1790                  * after we are done cancelling lock in that resource.
1791                  */
1792                 if (res != pres) {
1793                         if (pres != NULL) {
1794                                 ldlm_reprocess_all(pres, 0);
1795                                 LDLM_RESOURCE_DELREF(pres);
1796                                 ldlm_resource_putref(pres);
1797                         }
1798                         if (res != NULL) {
1799                                 ldlm_resource_getref(res);
1800                                 LDLM_RESOURCE_ADDREF(res);
1801
1802                                 if (!ldlm_is_discard_data(lock))
1803                                         ldlm_lvbo_update(res, lock,
1804                                                          NULL, 1);
1805                         }
1806                         pres = res;
1807                 }
1808
1809                 if ((flags & LATF_STATS) && ldlm_is_ast_sent(lock) &&
1810                     lock->l_blast_sent != 0) {
1811                         timeout_t delay = 0;
1812
1813                         if (ktime_get_seconds() > lock->l_blast_sent)
1814                                 delay = ktime_get_seconds() -
1815                                         lock->l_blast_sent;
1816                         LDLM_DEBUG(lock,
1817                                    "server cancels blocked lock after %ds",
1818                                    delay);
1819                         at_measured(&lock->l_export->exp_bl_lock_at, delay);
1820                 }
1821                 ldlm_lock_cancel(lock);
1822                 LDLM_LOCK_PUT(lock);
1823         }
1824         if (pres != NULL) {
1825                 ldlm_reprocess_all(pres, 0);
1826                 LDLM_RESOURCE_DELREF(pres);
1827                 ldlm_resource_putref(pres);
1828         }
1829         LDLM_DEBUG_NOLOCK("server-side cancel handler END");
1830         RETURN(done);
1831 }
1832 EXPORT_SYMBOL(ldlm_request_cancel);
1833
1834 /**
1835  * Main LDLM entry point for server code to cancel locks.
1836  *
1837  * Typically gets called from service handler on LDLM_CANCEL opc.
1838  */
1839 int ldlm_handle_cancel(struct ptlrpc_request *req)
1840 {
1841         struct ldlm_request *dlm_req;
1842         int rc;
1843
1844         ENTRY;
1845
1846         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1847         if (dlm_req == NULL) {
1848                 CDEBUG(D_INFO, "bad request buffer for cancel\n");
1849                 RETURN(-EFAULT);
1850         }
1851
1852         if (req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) <
1853             offsetof(struct ldlm_request, lock_handle[1]))
1854                 RETURN(-EPROTO);
1855
1856         if (req->rq_export && req->rq_export->exp_nid_stats &&
1857             req->rq_export->exp_nid_stats->nid_ldlm_stats)
1858                 lprocfs_counter_incr(req->rq_export->exp_nid_stats->nid_ldlm_stats,
1859                                      LDLM_CANCEL - LDLM_FIRST_OPC);
1860
1861         rc = req_capsule_server_pack(&req->rq_pill);
1862         if (rc)
1863                 RETURN(rc);
1864
1865         if (!ldlm_request_cancel(req, dlm_req, 0, LATF_STATS))
1866                 req->rq_status = LUSTRE_ESTALE;
1867
1868         RETURN(ptlrpc_reply(req));
1869 }
1870 #endif /* HAVE_SERVER_SUPPORT */
1871
1872 /**
1873  * Server may pass additional information about blocking lock.
1874  * For IBITS locks it is conflicting bits which can be used for
1875  * lock convert instead of cancel.
1876  */
1877 void ldlm_bl_desc2lock(const struct ldlm_lock_desc *ld, struct ldlm_lock *lock)
1878 {
1879         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1880
1881         check_res_locked(lock->l_resource);
1882         if (ns_is_client(ns) && ld &&
1883             (lock->l_resource->lr_type == LDLM_IBITS)) {
1884                 /*
1885                  * Lock description contains policy of blocking lock,
1886                  * and its cancel_bits is used to pass conflicting bits.
1887                  * NOTE: ld can be NULL or can be not NULL but zeroed if
1888                  * passed from ldlm_bl_thread_blwi(), check below used bits
1889                  * in ld to make sure it is valid description.
1890                  *
1891                  * If server may replace lock resource keeping the same cookie,
1892                  * never use cancel bits from different resource, full cancel
1893                  * is to be used.
1894                  */
1895                 if (ld->l_policy_data.l_inodebits.cancel_bits &&
1896                     ldlm_res_eq(&ld->l_resource.lr_name,
1897                                 &lock->l_resource->lr_name) &&
1898                     !(ldlm_is_cbpending(lock) &&
1899                       lock->l_policy_data.l_inodebits.cancel_bits == 0)) {
1900                         /* always combine conflicting ibits */
1901                         lock->l_policy_data.l_inodebits.cancel_bits |=
1902                                 ld->l_policy_data.l_inodebits.cancel_bits;
1903                 } else {
1904                         /* If cancel_bits are not obtained or
1905                          * if the lock is already CBPENDING and
1906                          * has no cancel_bits set
1907                          * - the full lock is to be cancelled
1908                          */
1909                         lock->l_policy_data.l_inodebits.cancel_bits = 0;
1910                 }
1911         }
1912 }
1913
1914 /**
1915  * Callback handler for receiving incoming blocking ASTs.
1916  *
1917  * This can only happen on client side.
1918  */
1919 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
1920                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock)
1921 {
1922         int do_ast;
1923
1924         ENTRY;
1925
1926         LDLM_DEBUG(lock, "client blocking AST callback handler");
1927
1928         lock_res_and_lock(lock);
1929
1930         /* get extra information from desc if any */
1931         ldlm_bl_desc2lock(ld, lock);
1932         ldlm_set_cbpending(lock);
1933
1934         do_ast = (!lock->l_readers && !lock->l_writers);
1935         unlock_res_and_lock(lock);
1936
1937         if (do_ast) {
1938                 CDEBUG(D_DLMTRACE,
1939                        "Lock %p already unused, calling callback (%p)\n",
1940                        lock, lock->l_blocking_ast);
1941                 if (lock->l_blocking_ast != NULL)
1942                         lock->l_blocking_ast(lock, ld, lock->l_ast_data,
1943                                              LDLM_CB_BLOCKING);
1944         } else {
1945                 CDEBUG(D_DLMTRACE,
1946                        "Lock %p is referenced, will be cancelled later\n",
1947                        lock);
1948         }
1949
1950         LDLM_DEBUG(lock, "client blocking callback handler END");
1951         LDLM_LOCK_RELEASE(lock);
1952         EXIT;
1953 }
1954
1955 static int ldlm_callback_reply(struct ptlrpc_request *req, int rc)
1956 {
1957         if (req->rq_no_reply)
1958                 return 0;
1959
1960         req->rq_status = rc;
1961         if (!req->rq_packed_final) {
1962                 rc = lustre_pack_reply(req, 1, NULL, NULL);
1963                 if (rc)
1964                         return rc;
1965         }
1966         return ptlrpc_reply(req);
1967 }
1968
1969 /**
1970  * Callback handler for receiving incoming completion ASTs.
1971  *
1972  * This only can happen on client side.
1973  */
1974 static int ldlm_handle_cp_callback(struct ptlrpc_request *req,
1975                                     struct ldlm_namespace *ns,
1976                                     struct ldlm_request *dlm_req,
1977                                     struct ldlm_lock *lock)
1978 {
1979         LIST_HEAD(ast_list);
1980         int lvb_len;
1981         int rc = 0;
1982
1983         ENTRY;
1984
1985         LDLM_DEBUG(lock, "client completion callback handler START");
1986
1987         if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_BL_CB_RACE)) {
1988                 long to = cfs_time_seconds(1);
1989
1990                 ldlm_callback_reply(req, 0);
1991
1992                 while (to > 0) {
1993                         to = schedule_timeout_interruptible(to);
1994                         if (ldlm_is_granted(lock) ||
1995                             ldlm_is_destroyed(lock))
1996                                 break;
1997                 }
1998         }
1999
2000         lvb_len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_LVB, RCL_CLIENT);
2001         if (lvb_len < 0) {
2002                 LDLM_ERROR(lock, "Fail to get lvb_len, rc = %d", lvb_len);
2003                 GOTO(out, rc = lvb_len);
2004         } else if (lvb_len > 0) {
2005                 if (lock->l_lvb_len > 0) {
2006                         /* for extent lock, lvb contains ost_lvb{}. */
2007                         LASSERT(lock->l_lvb_data != NULL);
2008
2009                         if (unlikely(lock->l_lvb_len < lvb_len)) {
2010                                 LDLM_ERROR(lock,
2011                                            "Replied LVB is larger than expectation, expected = %d, replied = %d",
2012                                            lock->l_lvb_len, lvb_len);
2013                                 GOTO(out, rc = -EINVAL);
2014                         }
2015                 }
2016         }
2017
2018         lock_res_and_lock(lock);
2019
2020         if (!ldlm_res_eq(&dlm_req->lock_desc.l_resource.lr_name,
2021                          &lock->l_resource->lr_name)) {
2022                 ldlm_resource_unlink_lock(lock);
2023                 unlock_res_and_lock(lock);
2024                 rc = ldlm_lock_change_resource(ns, lock,
2025                                 &dlm_req->lock_desc.l_resource.lr_name);
2026                 if (rc < 0) {
2027                         LDLM_ERROR(lock, "Failed to allocate resource");
2028                         GOTO(out, rc);
2029                 }
2030                 LDLM_DEBUG(lock, "completion AST, new resource");
2031                 lock_res_and_lock(lock);
2032         }
2033
2034         if (ldlm_is_failed(lock)) {
2035                 unlock_res_and_lock(lock);
2036                 LDLM_LOCK_RELEASE(lock);
2037                 RETURN(-EINVAL);
2038         }
2039
2040         if (ldlm_is_destroyed(lock) ||
2041             ldlm_is_granted(lock)) {
2042                 /* b=11300: the lock has already been granted */
2043                 unlock_res_and_lock(lock);
2044                 LDLM_DEBUG(lock, "Double grant race happened");
2045                 GOTO(out, rc = 0);
2046         }
2047
2048         /*
2049          * If we receive the completion AST before the actual enqueue returned,
2050          * then we might need to switch lock modes, resources, or extents.
2051          */
2052         if (dlm_req->lock_desc.l_granted_mode != lock->l_req_mode) {
2053                 lock->l_req_mode = dlm_req->lock_desc.l_granted_mode;
2054                 LDLM_DEBUG(lock, "completion AST, new lock mode");
2055         }
2056
2057         if (lock->l_resource->lr_type != LDLM_PLAIN) {
2058                 ldlm_convert_policy_to_local(req->rq_export,
2059                                           dlm_req->lock_desc.l_resource.lr_type,
2060                                           &dlm_req->lock_desc.l_policy_data,
2061                                           &lock->l_policy_data);
2062                 LDLM_DEBUG(lock, "completion AST, new policy data");
2063         }
2064
2065         ldlm_resource_unlink_lock(lock);
2066
2067         if (dlm_req->lock_flags & LDLM_FL_AST_SENT) {
2068                 /*
2069                  * BL_AST locks are not needed in LRU.
2070                  * Let ldlm_cancel_lru() be fast.
2071                  */
2072                 ldlm_lock_remove_from_lru(lock);
2073                 ldlm_bl_desc2lock(&dlm_req->lock_desc, lock);
2074                 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_BL_AST;
2075                 LDLM_DEBUG(lock, "completion AST includes blocking AST");
2076         }
2077
2078         if (lock->l_lvb_len > 0) {
2079                 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_CLIENT,
2080                                    lock->l_lvb_data, lvb_len);
2081                 if (rc < 0) {
2082                         unlock_res_and_lock(lock);
2083                         GOTO(out, rc);
2084                 }
2085         }
2086
2087         ldlm_grant_lock(lock, &ast_list);
2088         unlock_res_and_lock(lock);
2089
2090         LDLM_DEBUG(lock, "callback handler finished, about to run_ast_work");
2091
2092         /*
2093          * Let Enqueue to call osc_lock_upcall() and initialize
2094          * l_ast_data
2095          */
2096         OBD_FAIL_TIMEOUT(OBD_FAIL_OSC_CP_ENQ_RACE, 2);
2097
2098         ldlm_run_ast_work(ns, &ast_list, LDLM_WORK_CP_AST);
2099
2100         LDLM_DEBUG_NOLOCK("client completion callback handler END (lock %p)",
2101                           lock);
2102         GOTO(out, rc);
2103
2104 out:
2105         if (rc < 0) {
2106                 lock_res_and_lock(lock);
2107                 ldlm_set_failed(lock);
2108                 unlock_res_and_lock(lock);
2109                 wake_up(&lock->l_waitq);
2110         }
2111         LDLM_LOCK_RELEASE(lock);
2112
2113         return 0;
2114 }
2115
2116 /**
2117  * Callback handler for receiving incoming glimpse ASTs.
2118  *
2119  * This only can happen on client side.  After handling the glimpse AST
2120  * we also consider dropping the lock here if it is unused locally for a
2121  * long time.
2122  */
2123 static void ldlm_handle_gl_callback(struct ptlrpc_request *req,
2124                                     struct ldlm_namespace *ns,
2125                                     struct ldlm_request *dlm_req,
2126                                     struct ldlm_lock *lock)
2127 {
2128         struct ldlm_lock_desc *ld = &dlm_req->lock_desc;
2129         int rc = -ENOSYS;
2130
2131         ENTRY;
2132
2133         LDLM_DEBUG(lock, "client glimpse AST callback handler");
2134
2135         if (lock->l_glimpse_ast != NULL)
2136                 rc = lock->l_glimpse_ast(lock, req);
2137
2138         if (req->rq_repmsg != NULL) {
2139                 ptlrpc_reply(req);
2140         } else {
2141                 req->rq_status = rc;
2142                 ptlrpc_error(req);
2143         }
2144
2145         lock_res_and_lock(lock);
2146         if (lock->l_granted_mode == LCK_PW &&
2147             !lock->l_readers && !lock->l_writers &&
2148             ktime_after(ktime_get(),
2149                         ktime_add(lock->l_last_used, ns->ns_dirty_age_limit))) {
2150                 unlock_res_and_lock(lock);
2151
2152                 /* For MDS glimpse it is always DOM lock, set corresponding
2153                  * cancel_bits to perform lock convert if needed
2154                  */
2155                 if (lock->l_resource->lr_type == LDLM_IBITS)
2156                         ld->l_policy_data.l_inodebits.cancel_bits =
2157                                                         MDS_INODELOCK_DOM;
2158                 if (ldlm_bl_to_thread_lock(ns, ld, lock))
2159                         ldlm_handle_bl_callback(ns, ld, lock);
2160
2161                 EXIT;
2162                 return;
2163         }
2164         unlock_res_and_lock(lock);
2165         LDLM_LOCK_RELEASE(lock);
2166         EXIT;
2167 }
2168
2169 static int __ldlm_bl_to_thread(struct ldlm_bl_work_item *blwi,
2170                                enum ldlm_cancel_flags cancel_flags)
2171 {
2172         struct ldlm_bl_pool *blp = ldlm_state->ldlm_bl_pool;
2173         char *prio = "regular";
2174         int count;
2175
2176         ENTRY;
2177
2178         spin_lock(&blp->blp_lock);
2179         /* cannot access blwi after added to list and lock is dropped */
2180         count = blwi->blwi_lock ? 1 : blwi->blwi_count;
2181
2182         /* if the server is waiting on a lock to be cancelled (bl_ast), this is
2183          * an urgent request and should go in the priority queue so it doesn't
2184          * get stuck behind non-priority work (eg, lru size management)
2185          *
2186          * We also prioritize discard_data, which is for eviction handling
2187          */
2188         if (blwi->blwi_lock &&
2189             (ldlm_is_discard_data(blwi->blwi_lock) ||
2190              ldlm_is_bl_ast(blwi->blwi_lock))) {
2191                 list_add_tail(&blwi->blwi_entry, &blp->blp_prio_list);
2192                 prio = "priority";
2193         } else {
2194                 /* other blocking callbacks are added to the regular list */
2195                 list_add_tail(&blwi->blwi_entry, &blp->blp_list);
2196         }
2197         blp->blp_total_locks += count;
2198         blp->blp_total_blwis++;
2199         spin_unlock(&blp->blp_lock);
2200
2201         wake_up(&blp->blp_waitq);
2202
2203         /* unlocked read of blp values is intentional - OK for debug */
2204         CDEBUG(D_DLMTRACE,
2205                "added %d/%d locks to %s blp list, %d blwis in pool\n",
2206                count, blp->blp_total_locks, prio, blp->blp_total_blwis);
2207
2208         /*
2209          * can not check blwi->blwi_flags as blwi could be already freed in
2210          * LCF_ASYNC mode
2211          */
2212         if (!(cancel_flags & LCF_ASYNC))
2213                 wait_for_completion(&blwi->blwi_comp);
2214
2215         RETURN(0);
2216 }
2217
2218 static inline void init_blwi(struct ldlm_bl_work_item *blwi,
2219                              struct ldlm_namespace *ns,
2220                              struct ldlm_lock_desc *ld,
2221                              struct list_head *cancels, int count,
2222                              struct ldlm_lock *lock,
2223                              enum ldlm_cancel_flags cancel_flags)
2224 {
2225         init_completion(&blwi->blwi_comp);
2226         INIT_LIST_HEAD(&blwi->blwi_head);
2227
2228         if (current->flags & PF_MEMALLOC)
2229                 blwi->blwi_mem_pressure = 1;
2230
2231         blwi->blwi_ns = ns;
2232         blwi->blwi_flags = cancel_flags;
2233         if (ld != NULL)
2234                 blwi->blwi_ld = *ld;
2235         if (count) {
2236                 list_splice_init(cancels, &blwi->blwi_head);
2237                 blwi->blwi_count = count;
2238         } else {
2239                 blwi->blwi_lock = lock;
2240         }
2241 }
2242
2243 /**
2244  * Queues a list of locks \a cancels containing \a count locks
2245  * for later processing by a blocking thread.  If \a count is zero,
2246  * then the lock referenced as \a lock is queued instead.
2247  *
2248  * The blocking thread would then call ->l_blocking_ast callback in the lock.
2249  * If list addition fails an error is returned and caller is supposed to
2250  * call ->l_blocking_ast itself.
2251  */
2252 static int ldlm_bl_to_thread(struct ldlm_namespace *ns,
2253                              struct ldlm_lock_desc *ld,
2254                              struct ldlm_lock *lock,
2255                              struct list_head *cancels, int count,
2256                              enum ldlm_cancel_flags cancel_flags)
2257 {
2258         ENTRY;
2259
2260         if (cancels && count == 0)
2261                 RETURN(0);
2262
2263         if (cancel_flags & LCF_ASYNC) {
2264                 struct ldlm_bl_work_item *blwi;
2265
2266                 OBD_ALLOC(blwi, sizeof(*blwi));
2267                 if (blwi == NULL)
2268                         RETURN(-ENOMEM);
2269                 init_blwi(blwi, ns, ld, cancels, count, lock, cancel_flags);
2270
2271                 RETURN(__ldlm_bl_to_thread(blwi, cancel_flags));
2272         } else {
2273                 /*
2274                  * if it is synchronous call do minimum mem alloc, as it could
2275                  * be triggered from kernel shrinker
2276                  */
2277                 struct ldlm_bl_work_item blwi;
2278
2279                 memset(&blwi, 0, sizeof(blwi));
2280                 init_blwi(&blwi, ns, ld, cancels, count, lock, cancel_flags);
2281                 RETURN(__ldlm_bl_to_thread(&blwi, cancel_flags));
2282         }
2283 }
2284
2285
2286 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
2287                            struct ldlm_lock *lock)
2288 {
2289         return ldlm_bl_to_thread(ns, ld, lock, NULL, 0, LCF_ASYNC);
2290 }
2291
2292 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
2293                            struct list_head *cancels, int count,
2294                            enum ldlm_cancel_flags cancel_flags)
2295 {
2296         return ldlm_bl_to_thread(ns, ld, NULL, cancels, count, cancel_flags);
2297 }
2298
2299 int ldlm_bl_to_thread_ns(struct ldlm_namespace *ns)
2300 {
2301         return ldlm_bl_to_thread(ns, NULL, NULL, NULL, 0, LCF_ASYNC);
2302 }
2303
2304 int ldlm_bl_thread_wakeup(void)
2305 {
2306         wake_up(&ldlm_state->ldlm_bl_pool->blp_waitq);
2307         return 0;
2308 }
2309
2310 /* Setinfo coming from Server (eg MDT) to Client (eg MDC)! */
2311 static int ldlm_handle_setinfo(struct ptlrpc_request *req)
2312 {
2313         struct obd_device *obd = req->rq_export->exp_obd;
2314         char *key;
2315         void *val;
2316         int keylen, vallen;
2317         int rc = -ENOSYS;
2318
2319         ENTRY;
2320
2321         DEBUG_REQ(D_HSM, req, "%s: handle setinfo", obd->obd_name);
2322
2323         req_capsule_set(&req->rq_pill, &RQF_OBD_SET_INFO);
2324
2325         key = req_capsule_client_get(&req->rq_pill, &RMF_SETINFO_KEY);
2326         if (key == NULL) {
2327                 DEBUG_REQ(D_IOCTL, req, "no set_info key");
2328                 RETURN(-EFAULT);
2329         }
2330         keylen = req_capsule_get_size(&req->rq_pill, &RMF_SETINFO_KEY,
2331                                       RCL_CLIENT);
2332         val = req_capsule_client_get(&req->rq_pill, &RMF_SETINFO_VAL);
2333         if (val == NULL) {
2334                 DEBUG_REQ(D_IOCTL, req, "no set_info val");
2335                 RETURN(-EFAULT);
2336         }
2337         vallen = req_capsule_get_size(&req->rq_pill, &RMF_SETINFO_VAL,
2338                                       RCL_CLIENT);
2339
2340         /* We are responsible for swabbing contents of val */
2341
2342         if (KEY_IS(KEY_HSM_COPYTOOL_SEND))
2343                 /* Pass it on to mdc (the "export" in this case) */
2344                 rc = obd_set_info_async(req->rq_svc_thread->t_env,
2345                                         req->rq_export,
2346                                         sizeof(KEY_HSM_COPYTOOL_SEND),
2347                                         KEY_HSM_COPYTOOL_SEND,
2348                                         vallen, val, NULL);
2349         else
2350                 DEBUG_REQ(D_WARNING, req, "ignoring unknown key '%s'", key);
2351
2352         return rc;
2353 }
2354
2355 static inline void ldlm_callback_errmsg(struct ptlrpc_request *req,
2356                                         const char *msg, int rc,
2357                                         const struct lustre_handle *handle)
2358 {
2359         DEBUG_REQ((req->rq_no_reply || rc) ? D_WARNING : D_DLMTRACE, req,
2360                   "%s, NID=%s lock=%#llx: rc = %d",
2361                   msg, libcfs_idstr(&req->rq_peer),
2362                   handle ? handle->cookie : 0, rc);
2363         if (req->rq_no_reply)
2364                 CWARN("No reply was sent, maybe cause b=21636.\n");
2365         else if (rc)
2366                 CWARN("Send reply failed, maybe cause b=21636.\n");
2367 }
2368
2369 /* TODO: handle requests in a similar way as MDT: see mdt_handle_common() */
2370 static int ldlm_callback_handler(struct ptlrpc_request *req)
2371 {
2372         struct ldlm_namespace *ns;
2373         struct ldlm_request *dlm_req;
2374         struct ldlm_lock *lock;
2375         int rc;
2376
2377         ENTRY;
2378
2379         /*
2380          * Requests arrive in sender's byte order.  The ptlrpc service
2381          * handler has already checked and, if necessary, byte-swapped the
2382          * incoming request message body, but I am responsible for the
2383          * message buffers.
2384          */
2385
2386         /* do nothing for sec context finalize */
2387         if (lustre_msg_get_opc(req->rq_reqmsg) == SEC_CTX_FINI)
2388                 RETURN(0);
2389
2390         req_capsule_init(&req->rq_pill, req, RCL_SERVER);
2391
2392         if (req->rq_export == NULL) {
2393                 rc = ldlm_callback_reply(req, -ENOTCONN);
2394                 ldlm_callback_errmsg(req, "Operate on unconnected server",
2395                                      rc, NULL);
2396                 RETURN(0);
2397         }
2398
2399         LASSERT(req->rq_export != NULL);
2400         LASSERT(req->rq_export->exp_obd != NULL);
2401
2402         switch (lustre_msg_get_opc(req->rq_reqmsg)) {
2403         case LDLM_BL_CALLBACK:
2404                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_BL_CALLBACK_NET)) {
2405                         if (cfs_fail_err)
2406                                 ldlm_callback_reply(req, -(int)cfs_fail_err);
2407                         RETURN(0);
2408                 }
2409                 break;
2410         case LDLM_CP_CALLBACK:
2411                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CP_CALLBACK_NET))
2412                         RETURN(0);
2413                 break;
2414         case LDLM_GL_CALLBACK:
2415                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_GL_CALLBACK_NET))
2416                         RETURN(0);
2417                 break;
2418         case LDLM_SET_INFO:
2419                 rc = ldlm_handle_setinfo(req);
2420                 ldlm_callback_reply(req, rc);
2421                 RETURN(0);
2422         default:
2423                 CERROR("unknown opcode %u\n",
2424                        lustre_msg_get_opc(req->rq_reqmsg));
2425                 ldlm_callback_reply(req, -EPROTO);
2426                 RETURN(0);
2427         }
2428
2429         ns = req->rq_export->exp_obd->obd_namespace;
2430         LASSERT(ns != NULL);
2431
2432         req_capsule_set(&req->rq_pill, &RQF_LDLM_CALLBACK);
2433
2434         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2435         if (dlm_req == NULL) {
2436                 rc = ldlm_callback_reply(req, -EPROTO);
2437                 ldlm_callback_errmsg(req, "Operate without parameter", rc,
2438                                      NULL);
2439                 RETURN(0);
2440         }
2441
2442         /*
2443          * Force a known safe race, send a cancel to the server for a lock
2444          * which the server has already started a blocking callback on.
2445          */
2446         if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_BL_CB_RACE) &&
2447             lustre_msg_get_opc(req->rq_reqmsg) == LDLM_BL_CALLBACK) {
2448                 rc = ldlm_cli_cancel(&dlm_req->lock_handle[0], 0);
2449                 if (rc < 0)
2450                         CERROR("ldlm_cli_cancel: %d\n", rc);
2451         }
2452
2453         lock = ldlm_handle2lock_long(&dlm_req->lock_handle[0], 0);
2454         if (!lock) {
2455                 CDEBUG(D_DLMTRACE,
2456                        "callback on lock %#llx - lock disappeared\n",
2457                        dlm_req->lock_handle[0].cookie);
2458                 rc = ldlm_callback_reply(req, -EINVAL);
2459                 ldlm_callback_errmsg(req, "Operate with invalid parameter", rc,
2460                                      &dlm_req->lock_handle[0]);
2461                 RETURN(0);
2462         }
2463
2464         if (ldlm_is_fail_loc(lock) &&
2465             lustre_msg_get_opc(req->rq_reqmsg) == LDLM_BL_CALLBACK)
2466                 OBD_RACE(OBD_FAIL_LDLM_CP_BL_RACE);
2467
2468         /* Copy hints/flags (e.g. LDLM_FL_DISCARD_DATA) from AST. */
2469         lock_res_and_lock(lock);
2470         lock->l_flags |= ldlm_flags_from_wire(dlm_req->lock_flags &
2471                                               LDLM_FL_AST_MASK);
2472         if (lustre_msg_get_opc(req->rq_reqmsg) == LDLM_BL_CALLBACK) {
2473                 /*
2474                  * If somebody cancels lock and cache is already dropped,
2475                  * or lock is failed before cp_ast received on client,
2476                  * we can tell the server we have no lock. Otherwise, we
2477                  * should send cancel after dropping the cache.
2478                  */
2479                 if ((ldlm_is_canceling(lock) && ldlm_is_bl_done(lock)) ||
2480                      ldlm_is_failed(lock)) {
2481                         LDLM_DEBUG(lock,
2482                                    "callback on lock %llx - lock disappeared",
2483                                    dlm_req->lock_handle[0].cookie);
2484                         unlock_res_and_lock(lock);
2485                         LDLM_LOCK_RELEASE(lock);
2486                         rc = ldlm_callback_reply(req, -EINVAL);
2487                         ldlm_callback_errmsg(req, "Operate on stale lock", rc,
2488                                              &dlm_req->lock_handle[0]);
2489                         RETURN(0);
2490                 }
2491                 /*
2492                  * BL_AST locks are not needed in LRU.
2493                  * Let ldlm_cancel_lru() be fast.
2494                  */
2495                 ldlm_lock_remove_from_lru(lock);
2496                 ldlm_set_bl_ast(lock);
2497         }
2498         if (lock->l_remote_handle.cookie == 0)
2499                 lock->l_remote_handle = dlm_req->lock_handle[1];
2500         unlock_res_and_lock(lock);
2501
2502         /*
2503          * We want the ost thread to get this reply so that it can respond
2504          * to ost requests (write cache writeback) that might be triggered
2505          * in the callback.
2506          *
2507          * But we'd also like to be able to indicate in the reply that we're
2508          * cancelling right now, because it's unused, or have an intent result
2509          * in the reply, so we might have to push the responsibility for sending
2510          * the reply down into the AST handlers, alas.
2511          */
2512
2513         switch (lustre_msg_get_opc(req->rq_reqmsg)) {
2514         case LDLM_BL_CALLBACK:
2515                 LDLM_DEBUG(lock, "blocking ast\n");
2516                 req_capsule_extend(&req->rq_pill, &RQF_LDLM_BL_CALLBACK);
2517                 if (!ldlm_is_cancel_on_block(lock)) {
2518                         rc = ldlm_callback_reply(req, 0);
2519                         if (req->rq_no_reply || rc)
2520                                 ldlm_callback_errmsg(req, "Normal process", rc,
2521                                                      &dlm_req->lock_handle[0]);
2522                 }
2523                 if (ldlm_bl_to_thread_lock(ns, &dlm_req->lock_desc, lock))
2524                         ldlm_handle_bl_callback(ns, &dlm_req->lock_desc, lock);
2525                 break;
2526         case LDLM_CP_CALLBACK:
2527                 LDLM_DEBUG(lock, "completion ast\n");
2528                 req_capsule_extend(&req->rq_pill, &RQF_LDLM_CP_CALLBACK);
2529                 rc = ldlm_handle_cp_callback(req, ns, dlm_req, lock);
2530                 if (!OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_BL_CB_RACE))
2531                         ldlm_callback_reply(req, rc);
2532                 break;
2533         case LDLM_GL_CALLBACK:
2534                 LDLM_DEBUG(lock, "glimpse ast\n");
2535                 req_capsule_extend(&req->rq_pill, &RQF_LDLM_GL_CALLBACK);
2536                 ldlm_handle_gl_callback(req, ns, dlm_req, lock);
2537                 break;
2538         default:
2539                 LBUG(); /* checked above */
2540         }
2541
2542         RETURN(0);
2543 }
2544
2545 #ifdef HAVE_SERVER_SUPPORT
2546 /**
2547  * Main handler for canceld thread.
2548  *
2549  * Separated into its own thread to avoid deadlocks.
2550  */
2551 static int ldlm_cancel_handler(struct ptlrpc_request *req)
2552 {
2553         int rc;
2554
2555         ENTRY;
2556
2557         /*
2558          * Requests arrive in sender's byte order.  The ptlrpc service
2559          * handler has already checked and, if necessary, byte-swapped the
2560          * incoming request message body, but I am responsible for the
2561          * message buffers.
2562          */
2563
2564         req_capsule_init(&req->rq_pill, req, RCL_SERVER);
2565
2566         if (req->rq_export == NULL) {
2567                 struct ldlm_request *dlm_req;
2568
2569                 CERROR("%s from %s arrived at %llu with bad export cookie %llu\n",
2570                        ll_opcode2str(lustre_msg_get_opc(req->rq_reqmsg)),
2571                        libcfs_nidstr(&req->rq_peer.nid),
2572                        (unsigned long long)req->rq_arrival_time.tv_sec,
2573                        lustre_msg_get_handle(req->rq_reqmsg)->cookie);
2574
2575                 if (lustre_msg_get_opc(req->rq_reqmsg) == LDLM_CANCEL) {
2576                         req_capsule_set(&req->rq_pill, &RQF_LDLM_CALLBACK);
2577                         dlm_req = req_capsule_client_get(&req->rq_pill,
2578                                                          &RMF_DLM_REQ);
2579                         if (dlm_req != NULL)
2580                                 ldlm_lock_dump_handle(D_ERROR,
2581                                                       &dlm_req->lock_handle[0]);
2582                 }
2583                 ldlm_callback_reply(req, -ENOTCONN);
2584                 RETURN(0);
2585         }
2586
2587         switch (lustre_msg_get_opc(req->rq_reqmsg)) {
2588         /* XXX FIXME move this back to mds/handler.c, b=249 */
2589         case LDLM_CANCEL:
2590                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CANCEL);
2591                 CDEBUG(D_INODE, "cancel\n");
2592                 if (CFS_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_NET) ||
2593                     CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_CANCEL_RESEND) ||
2594                     CFS_FAIL_CHECK(OBD_FAIL_LDLM_BL_EVICT))
2595                         RETURN(0);
2596                 rc = ldlm_handle_cancel(req);
2597                 break;
2598         case LDLM_CONVERT:
2599         {
2600                 struct ldlm_request *dlm_req;
2601
2602                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CONVERT);
2603                 CDEBUG(D_INODE, "convert\n");
2604
2605                 dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2606                 if (dlm_req == NULL) {
2607                         CDEBUG(D_INFO, "bad request buffer for cancel\n");
2608                         rc = ldlm_callback_reply(req, -EPROTO);
2609                 } else {
2610                         req->rq_status = ldlm_handle_convert0(req, dlm_req);
2611                         rc = ptlrpc_reply(req);
2612                 }
2613                 break;
2614         }
2615         default:
2616                 CERROR("invalid opcode %d\n",
2617                        lustre_msg_get_opc(req->rq_reqmsg));
2618                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CALLBACK);
2619                 rc = ldlm_callback_reply(req, -EINVAL);
2620         }
2621
2622         RETURN(rc);
2623 }
2624
2625 static int ldlm_cancel_hpreq_lock_match(struct ptlrpc_request *req,
2626                                         struct ldlm_lock *lock)
2627 {
2628         struct ldlm_request *dlm_req;
2629         struct lustre_handle lockh;
2630         int rc = 0;
2631         int i;
2632
2633         ENTRY;
2634
2635         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2636         if (dlm_req == NULL)
2637                 RETURN(0);
2638
2639         ldlm_lock2handle(lock, &lockh);
2640         for (i = 0; i < dlm_req->lock_count; i++) {
2641                 if (lustre_handle_equal(&dlm_req->lock_handle[i],
2642                                         &lockh)) {
2643                         DEBUG_REQ(D_RPCTRACE, req,
2644                                   "Prio raised by lock %#llx", lockh.cookie);
2645                         rc = 1;
2646                         break;
2647                 }
2648         }
2649
2650         RETURN(rc);
2651 }
2652
2653 static int ldlm_cancel_hpreq_check(struct ptlrpc_request *req)
2654 {
2655         struct ldlm_request *dlm_req;
2656         int rc = 0;
2657         int i;
2658         unsigned int size;
2659
2660         ENTRY;
2661
2662         /* no prolong in recovery */
2663         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
2664                 RETURN(0);
2665
2666         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2667         if (dlm_req == NULL)
2668                 RETURN(-EFAULT);
2669
2670         size = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT);
2671         if (size <= offsetof(struct ldlm_request, lock_handle) ||
2672             (size - offsetof(struct ldlm_request, lock_handle)) /
2673              sizeof(struct lustre_handle) < dlm_req->lock_count)
2674                 RETURN(-EPROTO);
2675
2676         for (i = 0; i < dlm_req->lock_count; i++) {
2677                 struct ldlm_lock *lock;
2678
2679                 lock = ldlm_handle2lock(&dlm_req->lock_handle[i]);
2680                 if (lock == NULL)
2681                         continue;
2682
2683                 rc = ldlm_is_ast_sent(lock) ? 1 : 0;
2684                 if (rc)
2685                         LDLM_DEBUG(lock, "hpreq cancel/convert lock");
2686                 LDLM_LOCK_PUT(lock);
2687
2688                 if (rc)
2689                         break;
2690         }
2691
2692         RETURN(rc);
2693 }
2694
2695 static struct ptlrpc_hpreq_ops ldlm_cancel_hpreq_ops = {
2696         .hpreq_lock_match = ldlm_cancel_hpreq_lock_match,
2697         .hpreq_check      = ldlm_cancel_hpreq_check,
2698         .hpreq_fini       = NULL,
2699 };
2700
2701 static int ldlm_hpreq_handler(struct ptlrpc_request *req)
2702 {
2703         ENTRY;
2704
2705         req_capsule_init(&req->rq_pill, req, RCL_SERVER);
2706
2707         if (req->rq_export == NULL)
2708                 RETURN(0);
2709
2710         if (LDLM_CANCEL == lustre_msg_get_opc(req->rq_reqmsg)) {
2711                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CANCEL);
2712                 req->rq_ops = &ldlm_cancel_hpreq_ops;
2713         } else if (LDLM_CONVERT == lustre_msg_get_opc(req->rq_reqmsg)) {
2714                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CONVERT);
2715                 req->rq_ops = &ldlm_cancel_hpreq_ops;
2716         }
2717         RETURN(0);
2718 }
2719
2720 static int ldlm_revoke_lock_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2721                                struct hlist_node *hnode, void *data)
2722
2723 {
2724         struct list_head *rpc_list = data;
2725         struct ldlm_lock *lock = cfs_hash_object(hs, hnode);
2726
2727         lock_res_and_lock(lock);
2728
2729         if (!ldlm_is_granted(lock)) {
2730                 unlock_res_and_lock(lock);
2731                 return 0;
2732         }
2733
2734         LASSERT(lock->l_resource);
2735         if (lock->l_resource->lr_type != LDLM_IBITS &&
2736             lock->l_resource->lr_type != LDLM_PLAIN) {
2737                 unlock_res_and_lock(lock);
2738                 return 0;
2739         }
2740
2741         if (ldlm_is_ast_sent(lock)) {
2742                 unlock_res_and_lock(lock);
2743                 return 0;
2744         }
2745
2746         LASSERT(lock->l_blocking_ast);
2747         LASSERT(!lock->l_blocking_lock);
2748
2749         ldlm_set_ast_sent(lock);
2750         if (lock->l_export && lock->l_export->exp_lock_hash) {
2751                 /*
2752                  * NB: it's safe to call cfs_hash_del() even lock isn't
2753                  * in exp_lock_hash.
2754                  */
2755                 /*
2756                  * In the function below, .hs_keycmp resolves to
2757                  * ldlm_export_lock_keycmp()
2758                  */
2759                 /* coverity[overrun-buffer-val] */
2760                 cfs_hash_del(lock->l_export->exp_lock_hash,
2761                              &lock->l_remote_handle, &lock->l_exp_hash);
2762         }
2763
2764         list_add_tail(&lock->l_rk_ast, rpc_list);
2765         LDLM_LOCK_GET(lock);
2766
2767         unlock_res_and_lock(lock);
2768         return 0;
2769 }
2770
2771 void ldlm_revoke_export_locks(struct obd_export *exp)
2772 {
2773         int rc;
2774         LIST_HEAD(rpc_list);
2775         ENTRY;
2776
2777         cfs_hash_for_each_nolock(exp->exp_lock_hash,
2778                                  ldlm_revoke_lock_cb, &rpc_list, 0);
2779         rc = ldlm_run_ast_work(exp->exp_obd->obd_namespace, &rpc_list,
2780                           LDLM_WORK_REVOKE_AST);
2781
2782         if (rc == -ERESTART)
2783                 ldlm_reprocess_recovery_done(exp->exp_obd->obd_namespace);
2784
2785         EXIT;
2786 }
2787 EXPORT_SYMBOL(ldlm_revoke_export_locks);
2788 #endif /* HAVE_SERVER_SUPPORT */
2789
2790 static int ldlm_bl_get_work(struct ldlm_bl_pool *blp,
2791                             struct ldlm_bl_work_item **p_blwi,
2792                             struct obd_export **p_exp)
2793 {
2794         struct ldlm_bl_work_item *blwi = NULL;
2795         static unsigned int num_bl;
2796         static unsigned int num_stale;
2797         int num_th = atomic_read(&blp->blp_num_threads);
2798
2799         *p_exp = obd_stale_export_get();
2800
2801         spin_lock(&blp->blp_lock);
2802         if (*p_exp != NULL) {
2803                 if (num_th == 1 || ++num_stale < num_th) {
2804                         spin_unlock(&blp->blp_lock);
2805                         return 1;
2806                 }
2807                 num_stale = 0;
2808         }
2809
2810         /* process a request from the blp_list at least every blp_num_threads */
2811         if (!list_empty(&blp->blp_list) &&
2812             (list_empty(&blp->blp_prio_list) || num_bl == 0))
2813                 blwi = list_first_entry(&blp->blp_list,
2814                                         struct ldlm_bl_work_item, blwi_entry);
2815         else
2816                 if (!list_empty(&blp->blp_prio_list))
2817                         blwi = list_first_entry(&blp->blp_prio_list,
2818                                                 struct ldlm_bl_work_item,
2819                                                 blwi_entry);
2820
2821         if (blwi) {
2822                 if (++num_bl >= num_th)
2823                         num_bl = 0;
2824                 list_del(&blwi->blwi_entry);
2825                 blp->blp_total_locks -= blwi->blwi_lock ? 1 : blwi->blwi_count;
2826                 blp->blp_total_blwis--;
2827         }
2828         spin_unlock(&blp->blp_lock);
2829         *p_blwi = blwi;
2830
2831         /* intentional unlocked read of blp values - OK for debug */
2832         if (blwi) {
2833                 CDEBUG(D_DLMTRACE,
2834                        "Got %d locks of %d total in blp.  (%d blwis in pool)\n",
2835                        blwi->blwi_lock ? 1 : blwi->blwi_count,
2836                        blp->blp_total_locks, blp->blp_total_blwis);
2837         } else {
2838                 CDEBUG(D_DLMTRACE,
2839                        "No blwi found in queue (no bl locks in queue)\n");
2840         }
2841
2842         if (*p_exp != NULL && *p_blwi != NULL) {
2843                 obd_stale_export_put(*p_exp);
2844                 *p_exp = NULL;
2845         }
2846
2847         return (*p_blwi != NULL || *p_exp != NULL) ? 1 : 0;
2848 }
2849
2850 /* This only contains temporary data until the thread starts */
2851 struct ldlm_bl_thread_data {
2852         struct ldlm_bl_pool     *bltd_blp;
2853         struct completion       bltd_comp;
2854         int                     bltd_num;
2855 };
2856
2857 static int ldlm_bl_thread_main(void *arg);
2858
2859 static int ldlm_bl_thread_start(struct ldlm_bl_pool *blp, bool check_busy)
2860 {
2861         struct ldlm_bl_thread_data bltd = { .bltd_blp = blp };
2862         struct task_struct *task;
2863
2864         init_completion(&bltd.bltd_comp);
2865
2866         bltd.bltd_num = atomic_inc_return(&blp->blp_num_threads);
2867         if (bltd.bltd_num >= blp->blp_max_threads) {
2868                 atomic_dec(&blp->blp_num_threads);
2869                 return 0;
2870         }
2871
2872         LASSERTF(bltd.bltd_num > 0, "thread num:%d\n", bltd.bltd_num);
2873         if (check_busy &&
2874             atomic_read(&blp->blp_busy_threads) < (bltd.bltd_num - 1)) {
2875                 atomic_dec(&blp->blp_num_threads);
2876                 return 0;
2877         }
2878
2879         task = kthread_run(ldlm_bl_thread_main, &bltd, "ldlm_bl_%02d",
2880                            bltd.bltd_num);
2881         if (IS_ERR(task)) {
2882                 CERROR("cannot start LDLM thread ldlm_bl_%02d: rc %ld\n",
2883                        bltd.bltd_num, PTR_ERR(task));
2884                 atomic_dec(&blp->blp_num_threads);
2885                 return PTR_ERR(task);
2886         }
2887         wait_for_completion(&bltd.bltd_comp);
2888
2889         return 0;
2890 }
2891
2892 /* Not fatal if racy and have a few too many threads */
2893 static int ldlm_bl_thread_need_create(struct ldlm_bl_pool *blp,
2894                                       struct ldlm_bl_work_item *blwi)
2895 {
2896         if (atomic_read(&blp->blp_num_threads) >= blp->blp_max_threads)
2897                 return 0;
2898
2899         if (atomic_read(&blp->blp_busy_threads) <
2900             atomic_read(&blp->blp_num_threads))
2901                 return 0;
2902
2903         if (blwi != NULL && (blwi->blwi_ns == NULL ||
2904                              blwi->blwi_mem_pressure))
2905                 return 0;
2906
2907         return 1;
2908 }
2909
2910 static int ldlm_bl_thread_blwi(struct ldlm_bl_pool *blp,
2911                                struct ldlm_bl_work_item *blwi)
2912 {
2913         /* '1' for consistency with code that checks !mpflag to restore */
2914         unsigned int mpflags = 1;
2915
2916         ENTRY;
2917
2918         if (blwi->blwi_ns == NULL)
2919                 /* added by ldlm_cleanup() */
2920                 RETURN(LDLM_ITER_STOP);
2921
2922         if (blwi->blwi_mem_pressure)
2923                 mpflags = memalloc_noreclaim_save();
2924
2925         OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL2, 4);
2926
2927         if (blwi->blwi_count) {
2928                 int count;
2929                 /*
2930                  * The special case when we cancel locks in lru
2931                  * asynchronously, we pass the list of locks here.
2932                  * Thus locks are marked LDLM_FL_CANCELING, but NOT
2933                  * canceled locally yet.
2934                  */
2935                 count = ldlm_cli_cancel_list_local(&blwi->blwi_head,
2936                                                    blwi->blwi_count,
2937                                                    LCF_BL_AST);
2938                 ldlm_cli_cancel_list(&blwi->blwi_head, count, NULL,
2939                                      blwi->blwi_flags);
2940         } else if (blwi->blwi_lock) {
2941                 ldlm_handle_bl_callback(blwi->blwi_ns, &blwi->blwi_ld,
2942                                         blwi->blwi_lock);
2943         } else {
2944                 ldlm_pool_recalc(&blwi->blwi_ns->ns_pool, true);
2945                 spin_lock(&blwi->blwi_ns->ns_lock);
2946                 blwi->blwi_ns->ns_rpc_recalc = 0;
2947                 spin_unlock(&blwi->blwi_ns->ns_lock);
2948                 ldlm_namespace_put(blwi->blwi_ns);
2949         }
2950
2951         if (blwi->blwi_mem_pressure)
2952                 memalloc_noreclaim_restore(mpflags);
2953
2954         if (blwi->blwi_flags & LCF_ASYNC)
2955                 OBD_FREE(blwi, sizeof(*blwi));
2956         else
2957                 complete(&blwi->blwi_comp);
2958
2959         RETURN(0);
2960 }
2961
2962 /**
2963  * Cancel stale locks on export. Cancel blocked locks first.
2964  * If the given export has blocked locks, the next in the list may have
2965  * them too, thus cancel not blocked locks only if the current export has
2966  * no blocked locks.
2967  **/
2968 static int ldlm_bl_thread_exports(struct ldlm_bl_pool *blp,
2969                                   struct obd_export *exp)
2970 {
2971         int num;
2972
2973         ENTRY;
2974
2975         OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_BL_EVICT, 4);
2976
2977         num = ldlm_export_cancel_blocked_locks(exp);
2978         if (num == 0)
2979                 ldlm_export_cancel_locks(exp);
2980
2981         obd_stale_export_put(exp);
2982
2983         RETURN(0);
2984 }
2985
2986
2987 /**
2988  * Main blocking requests processing thread.
2989  *
2990  * Callers put locks into its queue by calling ldlm_bl_to_thread.
2991  * This thread in the end ends up doing actual call to ->l_blocking_ast
2992  * for queued locks.
2993  */
2994 static int ldlm_bl_thread_main(void *arg)
2995 {
2996         struct lu_env *env;
2997         struct ldlm_bl_pool *blp;
2998         struct ldlm_bl_thread_data *bltd = arg;
2999         int rc;
3000
3001         ENTRY;
3002
3003         OBD_ALLOC_PTR(env);
3004         if (!env)
3005                 RETURN(-ENOMEM);
3006         rc = lu_env_init(env, LCT_DT_THREAD);
3007         if (rc)
3008                 GOTO(out_env, rc);
3009         rc = lu_env_add(env);
3010         if (rc)
3011                 GOTO(out_env_fini, rc);
3012
3013         blp = bltd->bltd_blp;
3014
3015         complete(&bltd->bltd_comp);
3016         /* cannot use bltd after this, it is only on caller's stack */
3017
3018         while (1) {
3019                 struct ldlm_bl_work_item *blwi = NULL;
3020                 struct obd_export *exp = NULL;
3021                 int rc;
3022
3023                 rc = ldlm_bl_get_work(blp, &blwi, &exp);
3024
3025                 if (rc == 0)
3026                         wait_event_idle_exclusive(blp->blp_waitq,
3027                                                   ldlm_bl_get_work(blp, &blwi,
3028                                                                    &exp));
3029                 atomic_inc(&blp->blp_busy_threads);
3030
3031                 if (ldlm_bl_thread_need_create(blp, blwi))
3032                         /* discard the return value, we tried */
3033                         ldlm_bl_thread_start(blp, true);
3034
3035                 if (exp)
3036                         rc = ldlm_bl_thread_exports(blp, exp);
3037                 else if (blwi)
3038                         rc = ldlm_bl_thread_blwi(blp, blwi);
3039
3040                 atomic_dec(&blp->blp_busy_threads);
3041
3042                 if (rc == LDLM_ITER_STOP)
3043                         break;
3044
3045                 /*
3046                  * If there are many namespaces, we will not sleep waiting for
3047                  * work, and must do a cond_resched to avoid holding the CPU
3048                  * for too long
3049                  */
3050                 cond_resched();
3051         }
3052
3053         atomic_dec(&blp->blp_num_threads);
3054         complete(&blp->blp_comp);
3055
3056         lu_env_remove(env);
3057 out_env_fini:
3058         lu_env_fini(env);
3059 out_env:
3060         OBD_FREE_PTR(env);
3061         RETURN(rc);
3062 }
3063
3064
3065 static int ldlm_setup(void);
3066 static int ldlm_cleanup(void);
3067
3068 int ldlm_get_ref(void)
3069 {
3070         int rc = 0;
3071
3072         ENTRY;
3073         mutex_lock(&ldlm_ref_mutex);
3074         if (++ldlm_refcount == 1) {
3075                 rc = ldlm_setup();
3076                 if (rc)
3077                         ldlm_refcount--;
3078         }
3079         mutex_unlock(&ldlm_ref_mutex);
3080
3081         RETURN(rc);
3082 }
3083
3084 void ldlm_put_ref(void)
3085 {
3086         ENTRY;
3087         mutex_lock(&ldlm_ref_mutex);
3088         if (ldlm_refcount == 1) {
3089                 int rc = ldlm_cleanup();
3090
3091                 if (rc)
3092                         CERROR("ldlm_cleanup failed: %d\n", rc);
3093                 else
3094                         ldlm_refcount--;
3095         } else {
3096                 ldlm_refcount--;
3097         }
3098         mutex_unlock(&ldlm_ref_mutex);
3099
3100         EXIT;
3101 }
3102
3103 /*
3104  * Export handle<->lock hash operations.
3105  */
3106 static unsigned
3107 ldlm_export_lock_hash(struct cfs_hash *hs, const void *key, unsigned int mask)
3108 {
3109         return cfs_hash_64(((struct lustre_handle *)key)->cookie, 0) & mask;
3110 }
3111
3112 static void *
3113 ldlm_export_lock_key(struct hlist_node *hnode)
3114 {
3115         struct ldlm_lock *lock;
3116
3117         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3118         return &lock->l_remote_handle;
3119 }
3120
3121 static void
3122 ldlm_export_lock_keycpy(struct hlist_node *hnode, void *key)
3123 {
3124         struct ldlm_lock     *lock;
3125
3126         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3127         lock->l_remote_handle = *(struct lustre_handle *)key;
3128 }
3129
3130 static int
3131 ldlm_export_lock_keycmp(const void *key, struct hlist_node *hnode)
3132 {
3133         return lustre_handle_equal(ldlm_export_lock_key(hnode), key);
3134 }
3135
3136 static void *
3137 ldlm_export_lock_object(struct hlist_node *hnode)
3138 {
3139         return hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3140 }
3141
3142 static void
3143 ldlm_export_lock_get(struct cfs_hash *hs, struct hlist_node *hnode)
3144 {
3145         struct ldlm_lock *lock;
3146
3147         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3148         LDLM_LOCK_GET(lock);
3149 }
3150
3151 static void
3152 ldlm_export_lock_put(struct cfs_hash *hs, struct hlist_node *hnode)
3153 {
3154         struct ldlm_lock *lock;
3155
3156         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3157         LDLM_LOCK_RELEASE(lock);
3158 }
3159
3160 static struct cfs_hash_ops ldlm_export_lock_ops = {
3161         .hs_hash        = ldlm_export_lock_hash,
3162         .hs_key         = ldlm_export_lock_key,
3163         .hs_keycmp      = ldlm_export_lock_keycmp,
3164         .hs_keycpy      = ldlm_export_lock_keycpy,
3165         .hs_object      = ldlm_export_lock_object,
3166         .hs_get         = ldlm_export_lock_get,
3167         .hs_put         = ldlm_export_lock_put,
3168         .hs_put_locked  = ldlm_export_lock_put,
3169 };
3170
3171 int ldlm_init_export(struct obd_export *exp)
3172 {
3173         int rc;
3174
3175         ENTRY;
3176
3177         exp->exp_lock_hash =
3178                 cfs_hash_create(obd_uuid2str(&exp->exp_client_uuid),
3179                                 HASH_EXP_LOCK_CUR_BITS,
3180                                 HASH_EXP_LOCK_MAX_BITS,
3181                                 HASH_EXP_LOCK_BKT_BITS, 0,
3182                                 CFS_HASH_MIN_THETA, CFS_HASH_MAX_THETA,
3183                                 &ldlm_export_lock_ops,
3184                                 CFS_HASH_DEFAULT | CFS_HASH_REHASH_KEY |
3185                                 CFS_HASH_NBLK_CHANGE);
3186
3187         if (!exp->exp_lock_hash)
3188                 RETURN(-ENOMEM);
3189
3190         rc = ldlm_init_flock_export(exp);
3191         if (rc)
3192                 GOTO(err, rc);
3193
3194         RETURN(0);
3195 err:
3196         ldlm_destroy_export(exp);
3197         RETURN(rc);
3198 }
3199 EXPORT_SYMBOL(ldlm_init_export);
3200
3201 void ldlm_destroy_export(struct obd_export *exp)
3202 {
3203         ENTRY;
3204         cfs_hash_putref(exp->exp_lock_hash);
3205         exp->exp_lock_hash = NULL;
3206
3207         ldlm_destroy_flock_export(exp);
3208         EXIT;
3209 }
3210 EXPORT_SYMBOL(ldlm_destroy_export);
3211
3212 static ssize_t cancel_unused_locks_before_replay_show(struct kobject *kobj,
3213                                                       struct attribute *attr,
3214                                                       char *buf)
3215 {
3216         return sprintf(buf, "%d\n", ldlm_cancel_unused_locks_before_replay);
3217 }
3218
3219 static ssize_t cancel_unused_locks_before_replay_store(struct kobject *kobj,
3220                                                        struct attribute *attr,
3221                                                        const char *buffer,
3222                                                        size_t count)
3223 {
3224         int rc;
3225         unsigned long val;
3226
3227         rc = kstrtoul(buffer, 10, &val);
3228         if (rc)
3229                 return rc;
3230
3231         ldlm_cancel_unused_locks_before_replay = val;
3232
3233         return count;
3234 }
3235 LUSTRE_RW_ATTR(cancel_unused_locks_before_replay);
3236
3237 static struct attribute *ldlm_attrs[] = {
3238         &lustre_attr_cancel_unused_locks_before_replay.attr,
3239         NULL,
3240 };
3241
3242 static struct attribute_group ldlm_attr_group = {
3243         .attrs = ldlm_attrs,
3244 };
3245
3246 static int ldlm_setup(void)
3247 {
3248         static struct ptlrpc_service_conf       conf;
3249         struct ldlm_bl_pool                    *blp = NULL;
3250 #ifdef HAVE_SERVER_SUPPORT
3251         struct task_struct *task;
3252 #endif /* HAVE_SERVER_SUPPORT */
3253         int i;
3254         int rc = 0;
3255
3256         ENTRY;
3257
3258         if (ldlm_state != NULL)
3259                 RETURN(-EALREADY);
3260
3261         OBD_ALLOC(ldlm_state, sizeof(*ldlm_state));
3262         if (ldlm_state == NULL)
3263                 RETURN(-ENOMEM);
3264
3265         ldlm_kobj = kobject_create_and_add("ldlm", &lustre_kset->kobj);
3266         if (!ldlm_kobj)
3267                 GOTO(out, -ENOMEM);
3268
3269         rc = sysfs_create_group(ldlm_kobj, &ldlm_attr_group);
3270         if (rc)
3271                 GOTO(out, rc);
3272
3273         ldlm_ns_kset = kset_create_and_add("namespaces", NULL, ldlm_kobj);
3274         if (!ldlm_ns_kset)
3275                 GOTO(out, -ENOMEM);
3276
3277         ldlm_svc_kset = kset_create_and_add("services", NULL, ldlm_kobj);
3278         if (!ldlm_svc_kset)
3279                 GOTO(out, -ENOMEM);
3280
3281         rc = ldlm_debugfs_setup();
3282         if (rc != 0)
3283                 GOTO(out, rc);
3284
3285         memset(&conf, 0, sizeof(conf));
3286         conf = (typeof(conf)) {
3287                 .psc_name               = "ldlm_cbd",
3288                 .psc_watchdog_factor    = 2,
3289                 .psc_buf                = {
3290                         .bc_nbufs               = LDLM_CLIENT_NBUFS,
3291                         .bc_buf_size            = LDLM_BUFSIZE,
3292                         .bc_req_max_size        = LDLM_MAXREQSIZE,
3293                         .bc_rep_max_size        = LDLM_MAXREPSIZE,
3294                         .bc_req_portal          = LDLM_CB_REQUEST_PORTAL,
3295                         .bc_rep_portal          = LDLM_CB_REPLY_PORTAL,
3296                 },
3297                 .psc_thr                = {
3298                         .tc_thr_name            = "ldlm_cb",
3299                         .tc_thr_factor          = LDLM_THR_FACTOR,
3300                         .tc_nthrs_init          = LDLM_NTHRS_INIT,
3301                         .tc_nthrs_base          = LDLM_NTHRS_BASE,
3302                         .tc_nthrs_max           = LDLM_NTHRS_MAX,
3303                         .tc_nthrs_user          = ldlm_num_threads,
3304                         .tc_cpu_bind            = ldlm_cpu_bind,
3305                         .tc_ctx_tags            = LCT_MD_THREAD | LCT_DT_THREAD,
3306                 },
3307                 .psc_cpt                = {
3308                         .cc_pattern             = ldlm_cpts,
3309                         .cc_affinity            = true,
3310                 },
3311                 .psc_ops                = {
3312                         .so_req_handler         = ldlm_callback_handler,
3313                 },
3314         };
3315         ldlm_state->ldlm_cb_service = \
3316                         ptlrpc_register_service(&conf, ldlm_svc_kset,
3317                                                 ldlm_svc_debugfs_dir);
3318         if (IS_ERR(ldlm_state->ldlm_cb_service)) {
3319                 CERROR("failed to start service\n");
3320                 rc = PTR_ERR(ldlm_state->ldlm_cb_service);
3321                 ldlm_state->ldlm_cb_service = NULL;
3322                 GOTO(out, rc);
3323         }
3324
3325 #ifdef HAVE_SERVER_SUPPORT
3326         memset(&conf, 0, sizeof(conf));
3327         conf = (typeof(conf)) {
3328                 .psc_name               = "ldlm_canceld",
3329                 .psc_watchdog_factor    = 6,
3330                 .psc_buf                = {
3331                         .bc_nbufs               = LDLM_SERVER_NBUFS,
3332                         .bc_buf_size            = LDLM_BUFSIZE,
3333                         .bc_req_max_size        = LDLM_MAXREQSIZE,
3334                         .bc_rep_max_size        = LDLM_MAXREPSIZE,
3335                         .bc_req_portal          = LDLM_CANCEL_REQUEST_PORTAL,
3336                         .bc_rep_portal          = LDLM_CANCEL_REPLY_PORTAL,
3337
3338                 },
3339                 .psc_thr                = {
3340                         .tc_thr_name            = "ldlm_cn",
3341                         .tc_thr_factor          = LDLM_THR_FACTOR,
3342                         .tc_nthrs_init          = LDLM_NTHRS_INIT,
3343                         .tc_nthrs_base          = LDLM_NTHRS_BASE,
3344                         .tc_nthrs_max           = LDLM_NTHRS_MAX,
3345                         .tc_nthrs_user          = ldlm_num_threads,
3346                         .tc_cpu_bind            = ldlm_cpu_bind,
3347                         .tc_ctx_tags            = LCT_MD_THREAD | \
3348                                                   LCT_DT_THREAD | \
3349                                                   LCT_CL_THREAD,
3350                 },
3351                 .psc_cpt                = {
3352                         .cc_pattern             = ldlm_cpts,
3353                         .cc_affinity            = true,
3354                 },
3355                 .psc_ops                = {
3356                         .so_req_handler         = ldlm_cancel_handler,
3357                         .so_hpreq_handler       = ldlm_hpreq_handler,
3358                 },
3359         };
3360         ldlm_state->ldlm_cancel_service = \
3361                         ptlrpc_register_service(&conf, ldlm_svc_kset,
3362                                                 ldlm_svc_debugfs_dir);
3363         if (IS_ERR(ldlm_state->ldlm_cancel_service)) {
3364                 CERROR("failed to start service\n");
3365                 rc = PTR_ERR(ldlm_state->ldlm_cancel_service);
3366                 ldlm_state->ldlm_cancel_service = NULL;
3367                 GOTO(out, rc);
3368         }
3369 #endif /* HAVE_SERVER_SUPPORT */
3370
3371         OBD_ALLOC(blp, sizeof(*blp));
3372         if (blp == NULL)
3373                 GOTO(out, rc = -ENOMEM);
3374         ldlm_state->ldlm_bl_pool = blp;
3375
3376         spin_lock_init(&blp->blp_lock);
3377         INIT_LIST_HEAD(&blp->blp_list);
3378         INIT_LIST_HEAD(&blp->blp_prio_list);
3379         init_waitqueue_head(&blp->blp_waitq);
3380         atomic_set(&blp->blp_num_threads, 0);
3381         atomic_set(&blp->blp_busy_threads, 0);
3382         blp->blp_total_locks = 0;
3383         blp->blp_total_blwis = 0;
3384
3385         if (ldlm_num_threads == 0) {
3386                 blp->blp_min_threads = LDLM_NTHRS_INIT;
3387                 blp->blp_max_threads = LDLM_NTHRS_MAX;
3388         } else {
3389                 blp->blp_min_threads = blp->blp_max_threads = \
3390                         min_t(int, LDLM_NTHRS_MAX, max_t(int, LDLM_NTHRS_INIT,
3391                                                          ldlm_num_threads));
3392         }
3393
3394         for (i = 0; i < blp->blp_min_threads; i++) {
3395                 rc = ldlm_bl_thread_start(blp, false);
3396                 if (rc < 0)
3397                         GOTO(out, rc);
3398         }
3399
3400 #ifdef HAVE_SERVER_SUPPORT
3401         task = kthread_run(expired_lock_main, NULL, "ldlm_elt");
3402         if (IS_ERR(task)) {
3403                 rc = PTR_ERR(task);
3404                 CERROR("Cannot start ldlm expired-lock thread: %d\n", rc);
3405                 GOTO(out, rc);
3406         }
3407
3408         wait_event(expired_lock_wait_queue,
3409                    expired_lock_thread_state == ELT_READY);
3410 #endif /* HAVE_SERVER_SUPPORT */
3411
3412         rc = ldlm_pools_init();
3413         if (rc) {
3414                 CERROR("Failed to initialize LDLM pools: %d\n", rc);
3415                 GOTO(out, rc);
3416         }
3417
3418         rc = ldlm_reclaim_setup();
3419         if (rc) {
3420                 CERROR("Failed to setup reclaim thread: rc = %d\n", rc);
3421                 GOTO(out, rc);
3422         }
3423         RETURN(0);
3424
3425  out:
3426         ldlm_cleanup();
3427         RETURN(rc);
3428 }
3429
3430 static int ldlm_cleanup(void)
3431 {
3432         ENTRY;
3433
3434         if (!list_empty(ldlm_namespace_list(LDLM_NAMESPACE_SERVER)) ||
3435             !list_empty(ldlm_namespace_list(LDLM_NAMESPACE_CLIENT))) {
3436                 CERROR("ldlm still has namespaces; clean these up first.\n");
3437                 ldlm_dump_all_namespaces(LDLM_NAMESPACE_SERVER, D_DLMTRACE);
3438                 ldlm_dump_all_namespaces(LDLM_NAMESPACE_CLIENT, D_DLMTRACE);
3439                 RETURN(-EBUSY);
3440         }
3441
3442         ldlm_reclaim_cleanup();
3443         ldlm_pools_fini();
3444
3445         if (ldlm_state->ldlm_bl_pool != NULL) {
3446                 struct ldlm_bl_pool *blp = ldlm_state->ldlm_bl_pool;
3447
3448                 while (atomic_read(&blp->blp_num_threads) > 0) {
3449                         struct ldlm_bl_work_item blwi = { .blwi_ns = NULL };
3450
3451                         init_completion(&blp->blp_comp);
3452
3453                         spin_lock(&blp->blp_lock);
3454                         list_add_tail(&blwi.blwi_entry, &blp->blp_list);
3455                         wake_up(&blp->blp_waitq);
3456                         spin_unlock(&blp->blp_lock);
3457
3458                         wait_for_completion(&blp->blp_comp);
3459                 }
3460
3461                 OBD_FREE(blp, sizeof(*blp));
3462         }
3463
3464         if (ldlm_state->ldlm_cb_service != NULL)
3465                 ptlrpc_unregister_service(ldlm_state->ldlm_cb_service);
3466 #ifdef HAVE_SERVER_SUPPORT
3467         if (ldlm_state->ldlm_cancel_service != NULL)
3468                 ptlrpc_unregister_service(ldlm_state->ldlm_cancel_service);
3469 #endif
3470
3471         if (ldlm_ns_kset)
3472                 kset_unregister(ldlm_ns_kset);
3473         if (ldlm_svc_kset)
3474                 kset_unregister(ldlm_svc_kset);
3475         if (ldlm_kobj) {
3476                 sysfs_remove_group(ldlm_kobj, &ldlm_attr_group);
3477                 kobject_put(ldlm_kobj);
3478         }
3479
3480         ldlm_debugfs_cleanup();
3481
3482 #ifdef HAVE_SERVER_SUPPORT
3483         if (expired_lock_thread_state != ELT_STOPPED) {
3484                 expired_lock_thread_state = ELT_TERMINATE;
3485                 wake_up(&expired_lock_wait_queue);
3486                 wait_event(expired_lock_wait_queue,
3487                            expired_lock_thread_state == ELT_STOPPED);
3488         }
3489 #endif
3490
3491         OBD_FREE(ldlm_state, sizeof(*ldlm_state));
3492         ldlm_state = NULL;
3493
3494         RETURN(0);
3495 }
3496
3497 int ldlm_init(void)
3498 {
3499         ldlm_resource_slab = kmem_cache_create("ldlm_resources",
3500                                                sizeof(struct ldlm_resource), 0,
3501                                                SLAB_HWCACHE_ALIGN, NULL);
3502         if (ldlm_resource_slab == NULL)
3503                 return -ENOMEM;
3504
3505         ldlm_lock_slab = kmem_cache_create("ldlm_locks",
3506                               sizeof(struct ldlm_lock), 0,
3507                               SLAB_HWCACHE_ALIGN, NULL);
3508         if (ldlm_lock_slab == NULL)
3509                 goto out_resource;
3510
3511         ldlm_interval_slab = kmem_cache_create("interval_node",
3512                                         sizeof(struct ldlm_interval),
3513                                         0, SLAB_HWCACHE_ALIGN, NULL);
3514         if (ldlm_interval_slab == NULL)
3515                 goto out_lock;
3516
3517         ldlm_interval_tree_slab = kmem_cache_create("interval_tree",
3518                         sizeof(struct ldlm_interval_tree) * LCK_MODE_NUM,
3519                         0, SLAB_HWCACHE_ALIGN, NULL);
3520         if (ldlm_interval_tree_slab == NULL)
3521                 goto out_interval;
3522
3523 #ifdef HAVE_SERVER_SUPPORT
3524         ldlm_inodebits_slab = kmem_cache_create("ldlm_ibits_node",
3525                                                 sizeof(struct ldlm_ibits_node),
3526                                                 0, SLAB_HWCACHE_ALIGN, NULL);
3527         if (ldlm_inodebits_slab == NULL)
3528                 goto out_interval_tree;
3529
3530         ldlm_glimpse_work_kmem = kmem_cache_create("ldlm_glimpse_work_kmem",
3531                                         sizeof(struct ldlm_glimpse_work),
3532                                         0, 0, NULL);
3533         if (ldlm_glimpse_work_kmem == NULL)
3534                 goto out_inodebits;
3535 #endif
3536
3537 #if LUSTRE_TRACKS_LOCK_EXP_REFS
3538         class_export_dump_hook = ldlm_dump_export_locks;
3539 #endif
3540         return 0;
3541 #ifdef HAVE_SERVER_SUPPORT
3542 out_inodebits:
3543         kmem_cache_destroy(ldlm_inodebits_slab);
3544 out_interval_tree:
3545         kmem_cache_destroy(ldlm_interval_tree_slab);
3546 #endif
3547 out_interval:
3548         kmem_cache_destroy(ldlm_interval_slab);
3549 out_lock:
3550         kmem_cache_destroy(ldlm_lock_slab);
3551 out_resource:
3552         kmem_cache_destroy(ldlm_resource_slab);
3553
3554         return -ENOMEM;
3555 }
3556
3557 void ldlm_exit(void)
3558 {
3559         if (ldlm_refcount)
3560                 CERROR("ldlm_refcount is %d in ldlm_exit!\n", ldlm_refcount);
3561         synchronize_rcu();
3562         kmem_cache_destroy(ldlm_resource_slab);
3563         /*
3564          * ldlm_lock_put() use RCU to call ldlm_lock_free, so need call
3565          * rcu_barrier() to wait all outstanding RCU callbacks to complete,
3566          * so that ldlm_lock_free() get a chance to be called.
3567          */
3568         rcu_barrier();
3569         kmem_cache_destroy(ldlm_lock_slab);
3570         kmem_cache_destroy(ldlm_interval_slab);
3571         kmem_cache_destroy(ldlm_interval_tree_slab);
3572 #ifdef HAVE_SERVER_SUPPORT
3573         kmem_cache_destroy(ldlm_inodebits_slab);
3574         kmem_cache_destroy(ldlm_glimpse_work_kmem);
3575 #endif
3576 }