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