lustre/osc/osc_lock.c

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