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