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