lustre/osc/osc_lock.c

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