Whamcloud - gitweb
LU-12616 obclass: fix MDS start/stop race
[fs/lustre-release.git] / lustre / osc / osc_lock.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * Implementation of cl_lock for OSC layer.
33  *
34  *   Author: Nikita Danilov <nikita.danilov@sun.com>
35  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
36  */
37
38 #define DEBUG_SUBSYSTEM S_OSC
39
40 /* fid_build_reg_res_name() */
41 #include <lustre_fid.h>
42 #include <lustre_osc.h>
43
44 #include "osc_internal.h"
45
46 /** \addtogroup osc
47  *  @{
48  */
49
50 /**
51  * Returns a weak pointer to the ldlm lock identified by a handle. Returned
52  * pointer cannot be dereferenced, as lock is not protected from concurrent
53  * reclaim. This function is a helper for osc_lock_invariant().
54  */
55 static struct ldlm_lock *osc_handle_ptr(struct lustre_handle *handle)
56 {
57         struct ldlm_lock *lock;
58
59         lock = ldlm_handle2lock(handle);
60         if (lock != NULL)
61                 LDLM_LOCK_PUT(lock);
62         return lock;
63 }
64
65 /**
66  * Invariant that has to be true all of the time.
67  */
68 static int osc_lock_invariant(struct osc_lock *ols)
69 {
70         struct ldlm_lock *lock        = osc_handle_ptr(&ols->ols_handle);
71         struct ldlm_lock *olock       = ols->ols_dlmlock;
72         int               handle_used = lustre_handle_is_used(&ols->ols_handle);
73
74         if (ergo(osc_lock_is_lockless(ols),
75                  ols->ols_locklessable && ols->ols_dlmlock == NULL))
76                 return 1;
77
78         /*
79          * If all the following "ergo"s are true, return 1, otherwise 0
80          */
81         if (! ergo(olock != NULL, handle_used))
82                 return 0;
83
84         if (! ergo(olock != NULL,
85                    olock->l_handle.h_cookie == ols->ols_handle.cookie))
86                 return 0;
87
88         if (! ergo(handle_used,
89                    ergo(lock != NULL && olock != NULL, lock == olock) &&
90                    ergo(lock == NULL, olock == NULL)))
91                 return 0;
92         /*
93          * Check that ->ols_handle and ->ols_dlmlock are consistent, but
94          * take into account that they are set at the different time.
95          */
96         if (! ergo(ols->ols_state == OLS_CANCELLED,
97                    olock == NULL && !handle_used))
98                 return 0;
99         /*
100          * DLM lock is destroyed only after we have seen cancellation
101          * ast.
102          */
103         if (! ergo(olock != NULL && ols->ols_state < OLS_CANCELLED,
104                    !ldlm_is_destroyed(olock)))
105                 return 0;
106
107         if (! ergo(ols->ols_state == OLS_GRANTED,
108                    olock != NULL &&
109                    ldlm_is_granted(olock) &&
110                    ols->ols_hold))
111                 return 0;
112         return 1;
113 }
114
115 /*****************************************************************************
116  *
117  * Lock operations.
118  *
119  */
120
121 void osc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice)
122 {
123         struct osc_lock  *ols = cl2osc_lock(slice);
124
125         LINVRNT(osc_lock_invariant(ols));
126         LASSERT(ols->ols_dlmlock == NULL);
127
128         OBD_SLAB_FREE_PTR(ols, osc_lock_kmem);
129 }
130 EXPORT_SYMBOL(osc_lock_fini);
131
132 static void osc_lock_build_policy(const struct lu_env *env,
133                                   const struct cl_lock *lock,
134                                   union ldlm_policy_data *policy)
135 {
136         const struct cl_lock_descr *d = &lock->cll_descr;
137
138         osc_index2policy(policy, d->cld_obj, d->cld_start, d->cld_end);
139         policy->l_extent.gid = d->cld_gid;
140 }
141
142 /**
143  * Updates object attributes from a lock value block (lvb) received together
144  * with the DLM lock reply from the server. Copy of osc_update_enqueue()
145  * logic.
146  *
147  * This can be optimized to not update attributes when lock is a result of a
148  * local match.
149  *
150  * Called under lock and resource spin-locks.
151  */
152 static void osc_lock_lvb_update(const struct lu_env *env,
153                                 struct osc_object *osc,
154                                 struct ldlm_lock *dlmlock,
155                                 struct ost_lvb *lvb)
156 {
157         struct cl_object  *obj = osc2cl(osc);
158         struct lov_oinfo  *oinfo = osc->oo_oinfo;
159         struct cl_attr    *attr = &osc_env_info(env)->oti_attr;
160         unsigned           valid;
161
162         ENTRY;
163
164         valid = CAT_BLOCKS | CAT_ATIME | CAT_CTIME | CAT_MTIME | CAT_SIZE;
165         if (lvb == NULL) {
166                 LASSERT(dlmlock != NULL);
167                 lvb = dlmlock->l_lvb_data;
168         }
169         cl_lvb2attr(attr, lvb);
170
171         cl_object_attr_lock(obj);
172         if (dlmlock != NULL) {
173                 __u64 size;
174
175                 check_res_locked(dlmlock->l_resource);
176
177                 LASSERT(lvb == dlmlock->l_lvb_data);
178                 size = lvb->lvb_size;
179
180                 /* Extend KMS up to the end of this lock and no further
181                  * A lock on [x,y] means a KMS of up to y + 1 bytes! */
182                 if (size > dlmlock->l_policy_data.l_extent.end)
183                         size = dlmlock->l_policy_data.l_extent.end + 1;
184                 if (size >= oinfo->loi_kms) {
185                         LDLM_DEBUG(dlmlock, "lock acquired, setting rss=%llu"
186                                    ", kms=%llu", lvb->lvb_size, size);
187                         valid |= CAT_KMS;
188                         attr->cat_kms = size;
189                 } else {
190                         LDLM_DEBUG(dlmlock, "lock acquired, setting rss="
191                                    "%llu; leaving kms=%llu, end=%llu",
192                                    lvb->lvb_size, oinfo->loi_kms,
193                                    dlmlock->l_policy_data.l_extent.end);
194                 }
195                 ldlm_lock_allow_match_locked(dlmlock);
196         }
197
198         cl_object_attr_update(env, obj, attr, valid);
199         cl_object_attr_unlock(obj);
200
201         EXIT;
202 }
203
204 static void osc_lock_granted(const struct lu_env *env, struct osc_lock *oscl,
205                              struct lustre_handle *lockh, bool lvb_update)
206 {
207         struct ldlm_lock *dlmlock;
208
209         dlmlock = ldlm_handle2lock_long(lockh, 0);
210         LASSERT(dlmlock != NULL);
211
212         /* lock reference taken by ldlm_handle2lock_long() is
213          * owned by osc_lock and released in osc_lock_detach()
214          */
215         lu_ref_add(&dlmlock->l_reference, "osc_lock", oscl);
216         oscl->ols_has_ref = 1;
217
218         LASSERT(oscl->ols_dlmlock == NULL);
219         oscl->ols_dlmlock = dlmlock;
220
221         /* This may be a matched lock for glimpse request, do not hold
222          * lock reference in that case. */
223         if (!oscl->ols_glimpse) {
224                 /* hold a refc for non glimpse lock which will
225                  * be released in osc_lock_cancel() */
226                 lustre_handle_copy(&oscl->ols_handle, lockh);
227                 ldlm_lock_addref(lockh, oscl->ols_einfo.ei_mode);
228                 oscl->ols_hold = 1;
229         }
230
231         /* Lock must have been granted. */
232         lock_res_and_lock(dlmlock);
233         if (ldlm_is_granted(dlmlock)) {
234                 struct ldlm_extent *ext = &dlmlock->l_policy_data.l_extent;
235                 struct cl_lock_descr *descr = &oscl->ols_cl.cls_lock->cll_descr;
236
237                 /* extend the lock extent, otherwise it will have problem when
238                  * we decide whether to grant a lockless lock. */
239                 descr->cld_mode  = osc_ldlm2cl_lock(dlmlock->l_granted_mode);
240                 descr->cld_start = cl_index(descr->cld_obj, ext->start);
241                 descr->cld_end   = cl_index(descr->cld_obj, ext->end);
242                 descr->cld_gid   = ext->gid;
243
244                 /* no lvb update for matched lock */
245                 if (lvb_update) {
246                         LASSERT(oscl->ols_flags & LDLM_FL_LVB_READY);
247                         osc_lock_lvb_update(env, cl2osc(oscl->ols_cl.cls_obj),
248                                             dlmlock, NULL);
249                 }
250                 LINVRNT(osc_lock_invariant(oscl));
251         }
252         unlock_res_and_lock(dlmlock);
253
254         LASSERT(oscl->ols_state != OLS_GRANTED);
255         oscl->ols_state = OLS_GRANTED;
256 }
257
258 /**
259  * Lock upcall function that is executed either when a reply to ENQUEUE rpc is
260  * received from a server, or after osc_enqueue_base() matched a local DLM
261  * lock.
262  */
263 static int osc_lock_upcall(void *cookie, struct lustre_handle *lockh,
264                            int errcode)
265 {
266         struct osc_lock         *oscl  = cookie;
267         struct cl_lock_slice    *slice = &oscl->ols_cl;
268         struct lu_env           *env;
269         int                     rc;
270
271         ENTRY;
272
273         env = cl_env_percpu_get();
274         /* should never happen, similar to osc_ldlm_blocking_ast(). */
275         LASSERT(!IS_ERR(env));
276
277         rc = ldlm_error2errno(errcode);
278         if (oscl->ols_state == OLS_ENQUEUED) {
279                 oscl->ols_state = OLS_UPCALL_RECEIVED;
280         } else if (oscl->ols_state == OLS_CANCELLED) {
281                 rc = -EIO;
282         } else {
283                 CERROR("Impossible state: %d\n", oscl->ols_state);
284                 LBUG();
285         }
286
287         if (rc == 0)
288                 osc_lock_granted(env, oscl, lockh, errcode == ELDLM_OK);
289
290         /* Error handling, some errors are tolerable. */
291         if (oscl->ols_locklessable && rc == -EUSERS) {
292                 /* This is a tolerable error, turn this lock into
293                  * lockless lock.
294                  */
295                 osc_object_set_contended(cl2osc(slice->cls_obj));
296                 LASSERT(slice->cls_ops != oscl->ols_lockless_ops);
297
298                 /* Change this lock to ldlmlock-less lock. */
299                 osc_lock_to_lockless(env, oscl, 1);
300                 oscl->ols_state = OLS_GRANTED;
301                 rc = 0;
302         } else if (oscl->ols_glimpse && rc == -ENAVAIL) {
303                 LASSERT(oscl->ols_flags & LDLM_FL_LVB_READY);
304                 osc_lock_lvb_update(env, cl2osc(slice->cls_obj),
305                                     NULL, &oscl->ols_lvb);
306                 /* Hide the error. */
307                 rc = 0;
308         } else if (rc < 0 && oscl->ols_flags & LDLM_FL_NDELAY) {
309                 rc = -EWOULDBLOCK;
310         }
311
312         if (oscl->ols_owner != NULL)
313                 cl_sync_io_note(env, oscl->ols_owner, rc);
314         cl_env_percpu_put(env);
315
316         RETURN(rc);
317 }
318
319 static int osc_lock_upcall_speculative(void *cookie,
320                                        struct lustre_handle *lockh,
321                                        int errcode)
322 {
323         struct osc_object       *osc = cookie;
324         struct ldlm_lock        *dlmlock;
325         struct lu_env           *env;
326         __u16                    refcheck;
327         ENTRY;
328
329         env = cl_env_get(&refcheck);
330         LASSERT(!IS_ERR(env));
331
332         if (errcode == ELDLM_LOCK_MATCHED)
333                 GOTO(out, errcode = ELDLM_OK);
334
335         if (errcode != ELDLM_OK)
336                 GOTO(out, errcode);
337
338         dlmlock = ldlm_handle2lock(lockh);
339         LASSERT(dlmlock != NULL);
340
341         lock_res_and_lock(dlmlock);
342         LASSERT(ldlm_is_granted(dlmlock));
343
344         /* there is no osc_lock associated with speculative locks */
345         osc_lock_lvb_update(env, osc, dlmlock, NULL);
346
347         unlock_res_and_lock(dlmlock);
348         LDLM_LOCK_PUT(dlmlock);
349
350 out:
351         cl_object_put(env, osc2cl(osc));
352         cl_env_put(env, &refcheck);
353         RETURN(ldlm_error2errno(errcode));
354 }
355
356 static int osc_lock_flush(struct osc_object *obj, pgoff_t start, pgoff_t end,
357                           enum cl_lock_mode mode, bool discard)
358 {
359         struct lu_env           *env;
360         __u16                   refcheck;
361         int                     rc = 0;
362         int                     rc2 = 0;
363
364         ENTRY;
365
366         env = cl_env_get(&refcheck);
367         if (IS_ERR(env))
368                 RETURN(PTR_ERR(env));
369
370         if (mode == CLM_WRITE) {
371                 rc = osc_cache_writeback_range(env, obj, start, end, 1,
372                                                discard);
373                 CDEBUG(D_CACHE, "object %p: [%lu -> %lu] %d pages were %s.\n",
374                        obj, start, end, rc,
375                        discard ? "discarded" : "written back");
376                 if (rc > 0)
377                         rc = 0;
378         }
379
380         /*
381          * Do not try to match other locks with CLM_WRITE since we already
382          * know there're none
383          */
384         rc2 = osc_lock_discard_pages(env, obj, start, end,
385                                      mode == CLM_WRITE || discard);
386         if (rc == 0 && rc2 < 0)
387                 rc = rc2;
388
389         cl_env_put(env, &refcheck);
390         RETURN(rc);
391 }
392
393 /**
394  * Helper for osc_dlm_blocking_ast() handling discrepancies between cl_lock
395  * and ldlm_lock caches.
396  */
397 static int osc_dlm_blocking_ast0(const struct lu_env *env,
398                                  struct ldlm_lock *dlmlock,
399                                  void *data, int flag)
400 {
401         struct cl_object        *obj = NULL;
402         int                     result = 0;
403         bool                    discard;
404         enum cl_lock_mode       mode = CLM_READ;
405         ENTRY;
406
407         LASSERT(flag == LDLM_CB_CANCELING);
408
409         lock_res_and_lock(dlmlock);
410         if (!ldlm_is_granted(dlmlock)) {
411                 dlmlock->l_ast_data = NULL;
412                 unlock_res_and_lock(dlmlock);
413                 RETURN(0);
414         }
415
416         discard = ldlm_is_discard_data(dlmlock);
417         if (dlmlock->l_granted_mode & (LCK_PW | LCK_GROUP))
418                 mode = CLM_WRITE;
419
420         if (dlmlock->l_ast_data != NULL) {
421                 obj = osc2cl(dlmlock->l_ast_data);
422                 dlmlock->l_ast_data = NULL;
423
424                 cl_object_get(obj);
425         }
426
427         unlock_res_and_lock(dlmlock);
428
429         /* if l_ast_data is NULL, the dlmlock was enqueued by AGL or
430          * the object has been destroyed. */
431         if (obj != NULL) {
432                 struct ldlm_extent *extent = &dlmlock->l_policy_data.l_extent;
433                 struct cl_attr *attr = &osc_env_info(env)->oti_attr;
434                 __u64 old_kms;
435
436                 /* Destroy pages covered by the extent of the DLM lock */
437                 result = osc_lock_flush(cl2osc(obj),
438                                         cl_index(obj, extent->start),
439                                         cl_index(obj, extent->end),
440                                         mode, discard);
441
442                 /* losing a lock, update kms */
443                 lock_res_and_lock(dlmlock);
444                 cl_object_attr_lock(obj);
445                 /* Must get the value under the lock to avoid race. */
446                 old_kms = cl2osc(obj)->oo_oinfo->loi_kms;
447                 /* Update the kms. Need to loop all granted locks.
448                  * Not a problem for the client */
449                 attr->cat_kms = ldlm_extent_shift_kms(dlmlock, old_kms);
450
451                 cl_object_attr_update(env, obj, attr, CAT_KMS);
452                 cl_object_attr_unlock(obj);
453                 unlock_res_and_lock(dlmlock);
454
455                 cl_object_put(env, obj);
456         }
457         RETURN(result);
458 }
459
460 /**
461  * Blocking ast invoked by ldlm when dlm lock is either blocking progress of
462  * some other lock, or is canceled. This function is installed as a
463  * ldlm_lock::l_blocking_ast() for client extent locks.
464  *
465  * Control flow is tricky, because ldlm uses the same call-back
466  * (ldlm_lock::l_blocking_ast()) for both blocking and cancellation ast's.
467  *
468  * \param dlmlock lock for which ast occurred.
469  *
470  * \param new description of a conflicting lock in case of blocking ast.
471  *
472  * \param data value of dlmlock->l_ast_data
473  *
474  * \param flag LDLM_CB_BLOCKING or LDLM_CB_CANCELING. Used to distinguish
475  *             cancellation and blocking ast's.
476  *
477  * Possible use cases:
478  *
479  *     - ldlm calls dlmlock->l_blocking_ast(..., LDLM_CB_CANCELING) to cancel
480  *       lock due to lock lru pressure, or explicit user request to purge
481  *       locks.
482  *
483  *     - ldlm calls dlmlock->l_blocking_ast(..., LDLM_CB_BLOCKING) to notify
484  *       us that dlmlock conflicts with another lock that some client is
485  *       enqueuing. Lock is canceled.
486  *
487  *           - cl_lock_cancel() is called. osc_lock_cancel() calls
488  *             ldlm_cli_cancel() that calls
489  *
490  *                  dlmlock->l_blocking_ast(..., LDLM_CB_CANCELING)
491  *
492  *             recursively entering osc_ldlm_blocking_ast().
493  *
494  *     - client cancels lock voluntary (e.g., as a part of early cancellation):
495  *
496  *           cl_lock_cancel()->
497  *             osc_lock_cancel()->
498  *               ldlm_cli_cancel()->
499  *                 dlmlock->l_blocking_ast(..., LDLM_CB_CANCELING)
500  *
501  */
502 static int osc_ldlm_blocking_ast(struct ldlm_lock *dlmlock,
503                                  struct ldlm_lock_desc *new, void *data,
504                                  int flag)
505 {
506         int result = 0;
507         ENTRY;
508
509         switch (flag) {
510         case LDLM_CB_BLOCKING: {
511                 struct lustre_handle lockh;
512
513                 ldlm_lock2handle(dlmlock, &lockh);
514                 result = ldlm_cli_cancel(&lockh, LCF_ASYNC);
515                 if (result == -ENODATA)
516                         result = 0;
517                 break;
518         }
519         case LDLM_CB_CANCELING: {
520                 struct lu_env     *env;
521                 __u16              refcheck;
522
523                 /*
524                  * This can be called in the context of outer IO, e.g.,
525                  *
526                  *    osc_enqueue_base()->...
527                  *      ->ldlm_prep_elc_req()->...
528                  *        ->ldlm_cancel_callback()->...
529                  *          ->osc_ldlm_blocking_ast()
530                  *
531                  * new environment has to be created to not corrupt outer
532                  * context.
533                  */
534                 env = cl_env_get(&refcheck);
535                 if (IS_ERR(env)) {
536                         result = PTR_ERR(env);
537                         break;
538                 }
539
540                 result = osc_dlm_blocking_ast0(env, dlmlock, data, flag);
541                 cl_env_put(env, &refcheck);
542                 break;
543         }
544         default:
545                 LBUG();
546         }
547         RETURN(result);
548 }
549
550 int osc_ldlm_glimpse_ast(struct ldlm_lock *dlmlock, void *data)
551 {
552         struct ptlrpc_request   *req  = data;
553         struct lu_env           *env;
554         struct ost_lvb          *lvb;
555         struct req_capsule      *cap;
556         struct cl_object        *obj = NULL;
557         int                     result;
558         __u16                   refcheck;
559
560         ENTRY;
561
562         LASSERT(lustre_msg_get_opc(req->rq_reqmsg) == LDLM_GL_CALLBACK);
563
564         env = cl_env_get(&refcheck);
565         if (IS_ERR(env))
566                 GOTO(out, result = PTR_ERR(env));
567
568
569         lock_res_and_lock(dlmlock);
570         if (dlmlock->l_ast_data != NULL) {
571                 obj = osc2cl(dlmlock->l_ast_data);
572                 cl_object_get(obj);
573         }
574         unlock_res_and_lock(dlmlock);
575
576         if (obj != NULL) {
577                 /* Do not grab the mutex of cl_lock for glimpse.
578                  * See LU-1274 for details.
579                  * BTW, it's okay for cl_lock to be cancelled during
580                  * this period because server can handle this race.
581                  * See ldlm_server_glimpse_ast() for details.
582                  * cl_lock_mutex_get(env, lock); */
583                 cap = &req->rq_pill;
584                 req_capsule_extend(cap, &RQF_LDLM_GL_CALLBACK);
585                 req_capsule_set_size(cap, &RMF_DLM_LVB, RCL_SERVER,
586                                         sizeof *lvb);
587                 result = req_capsule_server_pack(cap);
588                 if (result == 0) {
589                         lvb = req_capsule_server_get(cap, &RMF_DLM_LVB);
590                         result = cl_object_glimpse(env, obj, lvb);
591                 }
592                 if (!exp_connect_lvb_type(req->rq_export))
593                         req_capsule_shrink(&req->rq_pill, &RMF_DLM_LVB,
594                                         sizeof(struct ost_lvb_v1), RCL_SERVER);
595                 cl_object_put(env, obj);
596         } else {
597                 /*
598                  * These errors are normal races, so we don't want to
599                  * fill the console with messages by calling
600                  * ptlrpc_error()
601                  */
602                 lustre_pack_reply(req, 1, NULL, NULL);
603                 result = -ELDLM_NO_LOCK_DATA;
604         }
605         cl_env_put(env, &refcheck);
606         EXIT;
607
608 out:
609         req->rq_status = result;
610         RETURN(result);
611 }
612 EXPORT_SYMBOL(osc_ldlm_glimpse_ast);
613
614 static int weigh_cb(const struct lu_env *env, struct cl_io *io,
615                     struct osc_page *ops, void *cbdata)
616 {
617         struct cl_page *page = ops->ops_cl.cpl_page;
618
619         if (cl_page_is_vmlocked(env, page) || PageDirty(page->cp_vmpage) ||
620             PageWriteback(page->cp_vmpage))
621                 return CLP_GANG_ABORT;
622
623         *(pgoff_t *)cbdata = osc_index(ops) + 1;
624         return CLP_GANG_OKAY;
625 }
626
627 static unsigned long osc_lock_weight(const struct lu_env *env,
628                                      struct osc_object *oscobj,
629                                      loff_t start, loff_t end)
630 {
631         struct cl_io *io = osc_env_thread_io(env);
632         struct cl_object *obj = cl_object_top(&oscobj->oo_cl);
633         pgoff_t page_index;
634         int result;
635
636         ENTRY;
637
638         io->ci_obj = obj;
639         io->ci_ignore_layout = 1;
640         result = cl_io_init(env, io, CIT_MISC, io->ci_obj);
641         if (result != 0)
642                 RETURN(result);
643
644         page_index = cl_index(obj, start);
645         do {
646                 result = osc_page_gang_lookup(env, io, oscobj,
647                                               page_index, cl_index(obj, end),
648                                               weigh_cb, (void *)&page_index);
649                 if (result == CLP_GANG_ABORT)
650                         break;
651                 if (result == CLP_GANG_RESCHED)
652                         cond_resched();
653         } while (result != CLP_GANG_OKAY);
654         cl_io_fini(env, io);
655
656         return result == CLP_GANG_ABORT ? 1 : 0;
657 }
658
659 /**
660  * Get the weight of dlm lock for early cancellation.
661  */
662 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock)
663 {
664         struct lu_env *env;
665         struct osc_object *obj;
666         struct osc_lock *oscl;
667         unsigned long weight;
668         bool found = false;
669         __u16 refcheck;
670
671         ENTRY;
672
673         might_sleep();
674         /*
675          * osc_ldlm_weigh_ast has a complex context since it might be called
676          * because of lock canceling, or from user's input. We have to make
677          * a new environment for it. Probably it is implementation safe to use
678          * the upper context because cl_lock_put don't modify environment
679          * variables. But just in case ..
680          */
681         env = cl_env_get(&refcheck);
682         if (IS_ERR(env))
683                 /* Mostly because lack of memory, do not eliminate this lock */
684                 RETURN(1);
685
686         LASSERT(dlmlock->l_resource->lr_type == LDLM_EXTENT ||
687                 dlmlock->l_resource->lr_type == LDLM_IBITS);
688
689         lock_res_and_lock(dlmlock);
690         obj = dlmlock->l_ast_data;
691         if (obj)
692                 cl_object_get(osc2cl(obj));
693         unlock_res_and_lock(dlmlock);
694
695         if (obj == NULL)
696                 GOTO(out, weight = 1);
697
698         spin_lock(&obj->oo_ol_spin);
699         list_for_each_entry(oscl, &obj->oo_ol_list, ols_nextlock_oscobj) {
700                 if (oscl->ols_dlmlock == dlmlock) {
701                         found = true;
702                         break;
703                 }
704         }
705         spin_unlock(&obj->oo_ol_spin);
706         if (found) {
707                 /*
708                  * If the lock is being used by an IO, definitely not cancel it.
709                  */
710                 GOTO(out, weight = 1);
711         }
712
713         if (dlmlock->l_resource->lr_type == LDLM_EXTENT)
714                 weight = osc_lock_weight(env, obj,
715                                          dlmlock->l_policy_data.l_extent.start,
716                                          dlmlock->l_policy_data.l_extent.end);
717         else if (ldlm_has_dom(dlmlock))
718                 weight = osc_lock_weight(env, obj, 0, OBD_OBJECT_EOF);
719         /* The DOM bit can be cancelled at any time; in that case, we know
720          * there are no pages, so just return weight of 0
721          */
722         else
723                 weight = 0;
724
725         EXIT;
726
727 out:
728         if (obj)
729                 cl_object_put(env, osc2cl(obj));
730
731         cl_env_put(env, &refcheck);
732         return weight;
733 }
734 EXPORT_SYMBOL(osc_ldlm_weigh_ast);
735
736 static void osc_lock_build_einfo(const struct lu_env *env,
737                                  const struct cl_lock *lock,
738                                  struct osc_object *osc,
739                                  struct ldlm_enqueue_info *einfo)
740 {
741         einfo->ei_type   = LDLM_EXTENT;
742         einfo->ei_mode   = osc_cl_lock2ldlm(lock->cll_descr.cld_mode);
743         einfo->ei_cb_bl  = osc_ldlm_blocking_ast;
744         einfo->ei_cb_cp  = ldlm_completion_ast;
745         einfo->ei_cb_gl  = osc_ldlm_glimpse_ast;
746         einfo->ei_cbdata = osc; /* value to be put into ->l_ast_data */
747 }
748
749 /**
750  * Determine if the lock should be converted into a lockless lock.
751  *
752  * Steps to check:
753  * - if the lock has an explicite requirment for a non-lockless lock;
754  * - if the io lock request type ci_lockreq;
755  * - send the enqueue rpc to ost to make the further decision;
756  * - special treat to truncate lockless lock
757  *
758  *  Additional policy can be implemented here, e.g., never do lockless-io
759  *  for large extents.
760  */
761 void osc_lock_to_lockless(const struct lu_env *env,
762                           struct osc_lock *ols, int force)
763 {
764         struct cl_lock_slice *slice = &ols->ols_cl;
765         struct osc_io *oio = osc_env_io(env);
766         struct cl_io *io = oio->oi_cl.cis_io;
767         struct cl_object *obj = slice->cls_obj;
768         struct osc_object *oob = cl2osc(obj);
769         const struct osc_device *osd = lu2osc_dev(obj->co_lu.lo_dev);
770         struct obd_connect_data *ocd;
771
772         LASSERT(ols->ols_state == OLS_NEW ||
773                 ols->ols_state == OLS_UPCALL_RECEIVED);
774
775         if (force) {
776                 ols->ols_locklessable = 1;
777                 slice->cls_ops = ols->ols_lockless_ops;
778         } else {
779                 LASSERT(io->ci_lockreq == CILR_MANDATORY ||
780                         io->ci_lockreq == CILR_MAYBE ||
781                         io->ci_lockreq == CILR_NEVER);
782
783                 ocd = &class_exp2cliimp(osc_export(oob))->imp_connect_data;
784                 ols->ols_locklessable = (io->ci_type != CIT_SETATTR) &&
785                                         (io->ci_lockreq == CILR_MAYBE) &&
786                                         (ocd->ocd_connect_flags &
787                                          OBD_CONNECT_SRVLOCK);
788                 if (io->ci_lockreq == CILR_NEVER ||
789                     /* lockless IO */
790                     (ols->ols_locklessable && osc_object_is_contended(oob)) ||
791                     /* lockless truncate */
792                     (cl_io_is_trunc(io) && osd->od_lockless_truncate &&
793                      (ocd->ocd_connect_flags & OBD_CONNECT_TRUNCLOCK))) {
794                         ols->ols_locklessable = 1;
795                         slice->cls_ops = ols->ols_lockless_ops;
796                 }
797         }
798         LASSERT(ergo(ols->ols_glimpse, !osc_lock_is_lockless(ols)));
799 }
800 EXPORT_SYMBOL(osc_lock_to_lockless);
801
802 static bool osc_lock_compatible(const struct osc_lock *qing,
803                                 const struct osc_lock *qed)
804 {
805         struct cl_lock_descr *qed_descr = &qed->ols_cl.cls_lock->cll_descr;
806         struct cl_lock_descr *qing_descr = &qing->ols_cl.cls_lock->cll_descr;
807
808         if (qed->ols_glimpse || qed->ols_speculative)
809                 return true;
810
811         if (qing_descr->cld_mode == CLM_READ && qed_descr->cld_mode == CLM_READ)
812                 return true;
813
814         if (qed->ols_state < OLS_GRANTED)
815                 return true;
816
817         if (qed_descr->cld_mode  >= qing_descr->cld_mode &&
818             qed_descr->cld_start <= qing_descr->cld_start &&
819             qed_descr->cld_end   >= qing_descr->cld_end)
820                 return true;
821
822         return false;
823 }
824
825 void osc_lock_wake_waiters(const struct lu_env *env, struct osc_object *osc,
826                            struct osc_lock *oscl)
827 {
828         spin_lock(&osc->oo_ol_spin);
829         list_del_init(&oscl->ols_nextlock_oscobj);
830         spin_unlock(&osc->oo_ol_spin);
831
832         spin_lock(&oscl->ols_lock);
833         while (!list_empty(&oscl->ols_waiting_list)) {
834                 struct osc_lock *scan;
835
836                 scan = list_entry(oscl->ols_waiting_list.next, struct osc_lock,
837                                   ols_wait_entry);
838                 list_del_init(&scan->ols_wait_entry);
839
840                 cl_sync_io_note(env, scan->ols_owner, 0);
841         }
842         spin_unlock(&oscl->ols_lock);
843 }
844 EXPORT_SYMBOL(osc_lock_wake_waiters);
845
846 int osc_lock_enqueue_wait(const struct lu_env *env, struct osc_object *obj,
847                           struct osc_lock *oscl)
848 {
849         struct osc_lock         *tmp_oscl;
850         struct cl_lock_descr    *need = &oscl->ols_cl.cls_lock->cll_descr;
851         struct cl_sync_io       *waiter = &osc_env_info(env)->oti_anchor;
852         int rc = 0;
853
854         ENTRY;
855
856         spin_lock(&obj->oo_ol_spin);
857         list_add_tail(&oscl->ols_nextlock_oscobj, &obj->oo_ol_list);
858
859 restart:
860         list_for_each_entry(tmp_oscl, &obj->oo_ol_list,
861                             ols_nextlock_oscobj) {
862                 struct cl_lock_descr *descr;
863
864                 if (tmp_oscl == oscl)
865                         break;
866
867                 descr = &tmp_oscl->ols_cl.cls_lock->cll_descr;
868                 if (descr->cld_start > need->cld_end ||
869                     descr->cld_end   < need->cld_start)
870                         continue;
871
872                 /* We're not supposed to give up group lock */
873                 if (descr->cld_mode == CLM_GROUP)
874                         break;
875
876                 if (!osc_lock_is_lockless(oscl) &&
877                     osc_lock_compatible(oscl, tmp_oscl))
878                         continue;
879
880                 /* wait for conflicting lock to be canceled */
881                 cl_sync_io_init(waiter, 1);
882                 oscl->ols_owner = waiter;
883
884                 spin_lock(&tmp_oscl->ols_lock);
885                 /* add oscl into tmp's ols_waiting list */
886                 list_add_tail(&oscl->ols_wait_entry,
887                               &tmp_oscl->ols_waiting_list);
888                 spin_unlock(&tmp_oscl->ols_lock);
889
890                 spin_unlock(&obj->oo_ol_spin);
891                 rc = cl_sync_io_wait(env, waiter, 0);
892                 spin_lock(&obj->oo_ol_spin);
893
894                 if (rc < 0)
895                         break;
896
897                 oscl->ols_owner = NULL;
898                 goto restart;
899         }
900         spin_unlock(&obj->oo_ol_spin);
901
902         RETURN(rc);
903 }
904 EXPORT_SYMBOL(osc_lock_enqueue_wait);
905
906 /**
907  * Implementation of cl_lock_operations::clo_enqueue() method for osc
908  * layer. This initiates ldlm enqueue:
909  *
910  *     - cancels conflicting locks early (osc_lock_enqueue_wait());
911  *
912  *     - calls osc_enqueue_base() to do actual enqueue.
913  *
914  * osc_enqueue_base() is supplied with an upcall function that is executed
915  * when lock is received either after a local cached ldlm lock is matched, or
916  * when a reply from the server is received.
917  *
918  * This function does not wait for the network communication to complete.
919  */
920 static int osc_lock_enqueue(const struct lu_env *env,
921                             const struct cl_lock_slice *slice,
922                             struct cl_io *unused, struct cl_sync_io *anchor)
923 {
924         struct osc_thread_info          *info  = osc_env_info(env);
925         struct osc_io                   *oio   = osc_env_io(env);
926         struct osc_object               *osc   = cl2osc(slice->cls_obj);
927         struct osc_lock                 *oscl  = cl2osc_lock(slice);
928         struct obd_export               *exp   = osc_export(osc);
929         struct cl_lock                  *lock  = slice->cls_lock;
930         struct ldlm_res_id              *resname = &info->oti_resname;
931         union ldlm_policy_data          *policy  = &info->oti_policy;
932         osc_enqueue_upcall_f            upcall   = osc_lock_upcall;
933         void                            *cookie  = oscl;
934         bool                            async    = false;
935         int                             result;
936
937         ENTRY;
938
939         LASSERTF(ergo(oscl->ols_glimpse, lock->cll_descr.cld_mode <= CLM_READ),
940                 "lock = %p, ols = %p\n", lock, oscl);
941
942         if (oscl->ols_state == OLS_GRANTED)
943                 RETURN(0);
944
945         if ((oscl->ols_flags & LDLM_FL_NO_EXPANSION) &&
946             !(exp_connect_lockahead_old(exp) || exp_connect_lockahead(exp))) {
947                 result = -EOPNOTSUPP;
948                 CERROR("%s: server does not support lockahead/locknoexpand:"
949                        "rc = %d\n", exp->exp_obd->obd_name, result);
950                 RETURN(result);
951         }
952
953         if (oscl->ols_flags & LDLM_FL_TEST_LOCK)
954                 GOTO(enqueue_base, 0);
955
956         /* For glimpse and/or speculative locks, do not wait for reply from
957          * server on LDLM request */
958         if (oscl->ols_glimpse || oscl->ols_speculative) {
959                 /* Speculative and glimpse locks do not have an anchor */
960                 LASSERT(equi(oscl->ols_speculative, anchor == NULL));
961                 async = true;
962                 GOTO(enqueue_base, 0);
963         }
964
965         result = osc_lock_enqueue_wait(env, osc, oscl);
966         if (result < 0)
967                 GOTO(out, result);
968
969         /* we can grant lockless lock right after all conflicting locks
970          * are canceled. */
971         if (osc_lock_is_lockless(oscl)) {
972                 oscl->ols_state = OLS_GRANTED;
973                 oio->oi_lockless = 1;
974                 RETURN(0);
975         }
976
977 enqueue_base:
978         oscl->ols_state = OLS_ENQUEUED;
979         if (anchor != NULL) {
980                 atomic_inc(&anchor->csi_sync_nr);
981                 oscl->ols_owner = anchor;
982         }
983
984         /**
985          * DLM lock's ast data must be osc_object;
986          * if glimpse or speculative lock, async of osc_enqueue_base()
987          * must be true
988          *
989          * For non-speculative locks:
990          * DLM's enqueue callback set to osc_lock_upcall() with cookie as
991          * osc_lock.
992          * For speculative locks:
993          * osc_lock_upcall_speculative & cookie is the osc object, since
994          * there is no osc_lock
995          */
996         ostid_build_res_name(&osc->oo_oinfo->loi_oi, resname);
997         osc_lock_build_policy(env, lock, policy);
998         if (oscl->ols_speculative) {
999                 oscl->ols_einfo.ei_cbdata = NULL;
1000                 /* hold a reference for callback */
1001                 cl_object_get(osc2cl(osc));
1002                 upcall = osc_lock_upcall_speculative;
1003                 cookie = osc;
1004         }
1005         result = osc_enqueue_base(exp, resname, &oscl->ols_flags,
1006                                   policy, &oscl->ols_lvb,
1007                                   osc->oo_oinfo->loi_kms_valid,
1008                                   upcall, cookie,
1009                                   &oscl->ols_einfo, PTLRPCD_SET, async,
1010                                   oscl->ols_speculative);
1011         if (result == 0) {
1012                 if (osc_lock_is_lockless(oscl)) {
1013                         oio->oi_lockless = 1;
1014                 } else if (!async) {
1015                         LASSERT(oscl->ols_state == OLS_GRANTED);
1016                         LASSERT(oscl->ols_hold);
1017                         LASSERT(oscl->ols_dlmlock != NULL);
1018                 }
1019         } else if (oscl->ols_speculative) {
1020                 cl_object_put(env, osc2cl(osc));
1021                 if (oscl->ols_glimpse) {
1022                         /* hide error for AGL request */
1023                         result = 0;
1024                 }
1025         }
1026
1027 out:
1028         if (result < 0) {
1029                 oscl->ols_state = OLS_CANCELLED;
1030                 osc_lock_wake_waiters(env, osc, oscl);
1031
1032                 if (anchor != NULL)
1033                         cl_sync_io_note(env, anchor, result);
1034         }
1035         RETURN(result);
1036 }
1037
1038 /**
1039  * Breaks a link between osc_lock and dlm_lock.
1040  */
1041 static void osc_lock_detach(const struct lu_env *env, struct osc_lock *olck)
1042 {
1043         struct ldlm_lock *dlmlock;
1044
1045         ENTRY;
1046
1047         dlmlock = olck->ols_dlmlock;
1048         if (dlmlock == NULL)
1049                 RETURN_EXIT;
1050
1051         if (olck->ols_hold) {
1052                 olck->ols_hold = 0;
1053                 ldlm_lock_decref(&olck->ols_handle, olck->ols_einfo.ei_mode);
1054                 olck->ols_handle.cookie = 0ULL;
1055         }
1056
1057         olck->ols_dlmlock = NULL;
1058
1059         /* release a reference taken in osc_lock_upcall(). */
1060         LASSERT(olck->ols_has_ref);
1061         lu_ref_del(&dlmlock->l_reference, "osc_lock", olck);
1062         LDLM_LOCK_RELEASE(dlmlock);
1063         olck->ols_has_ref = 0;
1064
1065         EXIT;
1066 }
1067
1068 /**
1069  * Implements cl_lock_operations::clo_cancel() method for osc layer. This is
1070  * called (as part of cl_lock_cancel()) when lock is canceled either voluntary
1071  * (LRU pressure, early cancellation, umount, etc.) or due to the conflict
1072  * with some other lock some where in the cluster. This function does the
1073  * following:
1074  *
1075  *     - invalidates all pages protected by this lock (after sending dirty
1076  *       ones to the server, as necessary);
1077  *
1078  *     - decref's underlying ldlm lock;
1079  *
1080  *     - cancels ldlm lock (ldlm_cli_cancel()).
1081  */
1082 void osc_lock_cancel(const struct lu_env *env,
1083                      const struct cl_lock_slice *slice)
1084 {
1085         struct osc_object *obj  = cl2osc(slice->cls_obj);
1086         struct osc_lock   *oscl = cl2osc_lock(slice);
1087
1088         ENTRY;
1089
1090         LINVRNT(osc_lock_invariant(oscl));
1091
1092         osc_lock_detach(env, oscl);
1093         oscl->ols_state = OLS_CANCELLED;
1094         oscl->ols_flags &= ~LDLM_FL_LVB_READY;
1095
1096         osc_lock_wake_waiters(env, obj, oscl);
1097         EXIT;
1098 }
1099 EXPORT_SYMBOL(osc_lock_cancel);
1100
1101 int osc_lock_print(const struct lu_env *env, void *cookie,
1102                    lu_printer_t p, const struct cl_lock_slice *slice)
1103 {
1104         struct osc_lock *lock = cl2osc_lock(slice);
1105
1106         (*p)(env, cookie, "%p %#llx %#llx %d %p ",
1107              lock->ols_dlmlock, lock->ols_flags, lock->ols_handle.cookie,
1108              lock->ols_state, lock->ols_owner);
1109         osc_lvb_print(env, cookie, p, &lock->ols_lvb);
1110         return 0;
1111 }
1112 EXPORT_SYMBOL(osc_lock_print);
1113
1114 static const struct cl_lock_operations osc_lock_ops = {
1115         .clo_fini    = osc_lock_fini,
1116         .clo_enqueue = osc_lock_enqueue,
1117         .clo_cancel  = osc_lock_cancel,
1118         .clo_print   = osc_lock_print,
1119 };
1120
1121 static void osc_lock_lockless_cancel(const struct lu_env *env,
1122                                      const struct cl_lock_slice *slice)
1123 {
1124         struct osc_lock      *ols   = cl2osc_lock(slice);
1125         struct osc_object    *osc   = cl2osc(slice->cls_obj);
1126         struct cl_lock_descr *descr = &slice->cls_lock->cll_descr;
1127         int result;
1128
1129         LASSERT(ols->ols_dlmlock == NULL);
1130         result = osc_lock_flush(osc, descr->cld_start, descr->cld_end,
1131                                 descr->cld_mode, false);
1132         if (result)
1133                 CERROR("Pages for lockless lock %p were not purged(%d)\n",
1134                        ols, result);
1135
1136         osc_lock_wake_waiters(env, osc, ols);
1137 }
1138
1139 static const struct cl_lock_operations osc_lock_lockless_ops = {
1140         .clo_fini      = osc_lock_fini,
1141         .clo_enqueue   = osc_lock_enqueue,
1142         .clo_cancel    = osc_lock_lockless_cancel,
1143         .clo_print     = osc_lock_print
1144 };
1145
1146 void osc_lock_set_writer(const struct lu_env *env, const struct cl_io *io,
1147                          struct cl_object *obj, struct osc_lock *oscl)
1148 {
1149         struct cl_lock_descr *descr = &oscl->ols_cl.cls_lock->cll_descr;
1150         pgoff_t io_start;
1151         pgoff_t io_end;
1152
1153         if (!cl_object_same(io->ci_obj, obj))
1154                 return;
1155
1156         if (likely(io->ci_type == CIT_WRITE)) {
1157                 io_start = cl_index(obj, io->u.ci_rw.crw_pos);
1158                 io_end = cl_index(obj, io->u.ci_rw.crw_pos +
1159                                                 io->u.ci_rw.crw_count - 1);
1160         } else {
1161                 LASSERT(cl_io_is_mkwrite(io));
1162                 io_start = io_end = io->u.ci_fault.ft_index;
1163         }
1164
1165         if (descr->cld_mode >= CLM_WRITE &&
1166             (cl_io_is_append(io) ||
1167              (descr->cld_start <= io_start && descr->cld_end >= io_end))) {
1168                 struct osc_io *oio = osc_env_io(env);
1169
1170                 /* There must be only one lock to match the write region */
1171                 LASSERT(oio->oi_write_osclock == NULL);
1172                 oio->oi_write_osclock = oscl;
1173         }
1174 }
1175 EXPORT_SYMBOL(osc_lock_set_writer);
1176
1177 int osc_lock_init(const struct lu_env *env,
1178                   struct cl_object *obj, struct cl_lock *lock,
1179                   const struct cl_io *io)
1180 {
1181         struct osc_lock *oscl;
1182         __u32 enqflags = lock->cll_descr.cld_enq_flags;
1183
1184         OBD_SLAB_ALLOC_PTR_GFP(oscl, osc_lock_kmem, GFP_NOFS);
1185         if (oscl == NULL)
1186                 return -ENOMEM;
1187
1188         oscl->ols_state = OLS_NEW;
1189         spin_lock_init(&oscl->ols_lock);
1190         INIT_LIST_HEAD(&oscl->ols_waiting_list);
1191         INIT_LIST_HEAD(&oscl->ols_wait_entry);
1192         INIT_LIST_HEAD(&oscl->ols_nextlock_oscobj);
1193         oscl->ols_lockless_ops = &osc_lock_lockless_ops;
1194
1195         /* Speculative lock requests must be either no_expand or glimpse
1196          * request (CEF_GLIMPSE).  non-glimpse no_expand speculative extent
1197          * locks will break ofd_intent_cb. (see comment there)*/
1198         LASSERT(ergo((enqflags & CEF_SPECULATIVE) != 0,
1199                 (enqflags & (CEF_LOCK_NO_EXPAND | CEF_GLIMPSE)) != 0));
1200
1201         oscl->ols_flags = osc_enq2ldlm_flags(enqflags);
1202         oscl->ols_speculative = !!(enqflags & CEF_SPECULATIVE);
1203
1204         if (oscl->ols_flags & LDLM_FL_HAS_INTENT) {
1205                 oscl->ols_flags |= LDLM_FL_BLOCK_GRANTED;
1206                 oscl->ols_glimpse = 1;
1207         }
1208         if (io->ci_ndelay && cl_object_same(io->ci_obj, obj))
1209                 oscl->ols_flags |= LDLM_FL_NDELAY;
1210         osc_lock_build_einfo(env, lock, cl2osc(obj), &oscl->ols_einfo);
1211
1212         cl_lock_slice_add(lock, &oscl->ols_cl, obj, &osc_lock_ops);
1213
1214         if (!(enqflags & CEF_MUST))
1215                 /* try to convert this lock to a lockless lock */
1216                 osc_lock_to_lockless(env, oscl, (enqflags & CEF_NEVER));
1217         if (oscl->ols_locklessable && !(enqflags & CEF_DISCARD_DATA))
1218                 oscl->ols_flags |= LDLM_FL_DENY_ON_CONTENTION;
1219
1220         if (io->ci_type == CIT_WRITE || cl_io_is_mkwrite(io))
1221                 osc_lock_set_writer(env, io, obj, oscl);
1222
1223         LDLM_DEBUG_NOLOCK("lock %p, osc lock %p, flags %#llx",
1224                           lock, oscl, oscl->ols_flags);
1225
1226         return 0;
1227 }
1228
1229 /**
1230  * Finds an existing lock covering given index and optionally different from a
1231  * given \a except lock.
1232  */
1233 struct ldlm_lock *osc_obj_dlmlock_at_pgoff(const struct lu_env *env,
1234                                            struct osc_object *obj,
1235                                            pgoff_t index,
1236                                            enum osc_dap_flags dap_flags)
1237 {
1238         struct osc_thread_info *info = osc_env_info(env);
1239         struct ldlm_res_id *resname = &info->oti_resname;
1240         union ldlm_policy_data *policy  = &info->oti_policy;
1241         struct lustre_handle lockh;
1242         struct ldlm_lock *lock = NULL;
1243         enum ldlm_mode mode;
1244         __u64 flags;
1245
1246         ENTRY;
1247
1248         ostid_build_res_name(&obj->oo_oinfo->loi_oi, resname);
1249         osc_index2policy(policy, osc2cl(obj), index, index);
1250         policy->l_extent.gid = LDLM_GID_ANY;
1251
1252         flags = LDLM_FL_BLOCK_GRANTED | LDLM_FL_CBPENDING;
1253         if (dap_flags & OSC_DAP_FL_TEST_LOCK)
1254                 flags |= LDLM_FL_TEST_LOCK;
1255         /*
1256          * It is fine to match any group lock since there could be only one
1257          * with a uniq gid and it conflicts with all other lock modes too
1258          */
1259 again:
1260         mode = osc_match_base(osc_export(obj), resname, LDLM_EXTENT, policy,
1261                                LCK_PR | LCK_PW | LCK_GROUP, &flags, obj, &lockh,
1262                                dap_flags & OSC_DAP_FL_CANCELING);
1263         if (mode != 0) {
1264                 lock = ldlm_handle2lock(&lockh);
1265                 /* RACE: the lock is cancelled so let's try again */
1266                 if (unlikely(lock == NULL))
1267                         goto again;
1268         }
1269
1270         RETURN(lock);
1271 }
1272 /** @} osc */