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