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