lustre/osc/osc_object.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, 2015, 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_object 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 #include <lustre_osc.h>
  40
  41 #include "osc_internal.h"
  42
  43 /** \addtogroup osc
  44  *  @{
  45  */
  46
  47 /*****************************************************************************
  48  *
  49  * Object operations.
  50  *
  51  */
  52 int osc_object_init(const struct lu_env *env, struct lu_object *obj,
  53                     const struct lu_object_conf *conf)
  54 {
  55         struct osc_object           *osc   = lu2osc(obj);
  56         const struct cl_object_conf *cconf = lu2cl_conf(conf);
  57
  58         osc->oo_oinfo = cconf->u.coc_oinfo;
  59 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
  60         mutex_init(&osc->oo_debug_mutex);
  61 #endif
  62         INIT_LIST_HEAD(&osc->oo_ready_item);
  63         INIT_LIST_HEAD(&osc->oo_hp_ready_item);
  64         INIT_LIST_HEAD(&osc->oo_write_item);
  65         INIT_LIST_HEAD(&osc->oo_read_item);
  66
  67         osc->oo_root.rb_node = NULL;
  68         INIT_LIST_HEAD(&osc->oo_hp_exts);
  69         INIT_LIST_HEAD(&osc->oo_urgent_exts);
  70         INIT_LIST_HEAD(&osc->oo_full_exts);
  71         INIT_LIST_HEAD(&osc->oo_reading_exts);
  72         atomic_set(&osc->oo_nr_reads, 0);
  73         atomic_set(&osc->oo_nr_writes, 0);
  74         spin_lock_init(&osc->oo_lock);
  75         spin_lock_init(&osc->oo_tree_lock);
  76         spin_lock_init(&osc->oo_ol_spin);
  77         INIT_LIST_HEAD(&osc->oo_ol_list);
  78
  79         atomic_set(&osc->oo_nr_ios, 0);
  80         init_waitqueue_head(&osc->oo_io_waitq);
  81
  82         cl_object_page_init(lu2cl(obj), sizeof(struct osc_page));
  83
  84         return 0;
  85 }
  86 EXPORT_SYMBOL(osc_object_init);
  87
  88 void osc_object_free(const struct lu_env *env, struct lu_object *obj)
  89 {
  90         struct osc_object *osc = lu2osc(obj);
  91
  92         LASSERT(list_empty(&osc->oo_ready_item));
  93         LASSERT(list_empty(&osc->oo_hp_ready_item));
  94         LASSERT(list_empty(&osc->oo_write_item));
  95         LASSERT(list_empty(&osc->oo_read_item));
  96
  97         LASSERT(osc->oo_root.rb_node == NULL);
  98         LASSERT(list_empty(&osc->oo_hp_exts));
  99         LASSERT(list_empty(&osc->oo_urgent_exts));
 100         LASSERT(list_empty(&osc->oo_full_exts));
 101         LASSERT(list_empty(&osc->oo_reading_exts));
 102         LASSERT(atomic_read(&osc->oo_nr_reads) == 0);
 103         LASSERT(atomic_read(&osc->oo_nr_writes) == 0);
 104         LASSERT(list_empty(&osc->oo_ol_list));
 105         LASSERT(atomic_read(&osc->oo_nr_ios) == 0);
 106
 107         lu_object_fini(obj);
 108         OBD_SLAB_FREE_PTR(osc, osc_object_kmem);
 109 }
 110 EXPORT_SYMBOL(osc_object_free);
 111
 112 int osc_lvb_print(const struct lu_env *env, void *cookie,
 113                   lu_printer_t p, const struct ost_lvb *lvb)
 114 {
 115         return (*p)(env, cookie, "size: %llu mtime: %llu atime: %llu "
 116                     "ctime: %llu blocks: %llu",
 117                     lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
 118                     lvb->lvb_ctime, lvb->lvb_blocks);
 119 }
 120 EXPORT_SYMBOL(osc_lvb_print);
 121
 122 int osc_object_print(const struct lu_env *env, void *cookie,
 123                      lu_printer_t p, const struct lu_object *obj)
 124 {
 125         struct osc_object *osc = lu2osc(obj);
 126         struct lov_oinfo *oinfo = osc->oo_oinfo;
 127         struct osc_async_rc *ar = &oinfo->loi_ar;
 128
 129         (*p)(env, cookie, "id: "DOSTID" "
 130              "idx: %d gen: %d kms_valid: %u kms %llu "
 131              "rc: %d force_sync: %d min_xid: %llu ",
 132              POSTID(&oinfo->loi_oi), oinfo->loi_ost_idx,
 133              oinfo->loi_ost_gen, oinfo->loi_kms_valid, oinfo->loi_kms,
 134              ar->ar_rc, ar->ar_force_sync, ar->ar_min_xid);
 135         osc_lvb_print(env, cookie, p, &oinfo->loi_lvb);
 136         return 0;
 137 }
 138 EXPORT_SYMBOL(osc_object_print);
 139
 140
 141 int osc_attr_get(const struct lu_env *env, struct cl_object *obj,
 142                  struct cl_attr *attr)
 143 {
 144         struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
 145
 146         cl_lvb2attr(attr, &oinfo->loi_lvb);
 147         attr->cat_kms = oinfo->loi_kms_valid ? oinfo->loi_kms : 0;
 148         return 0;
 149 }
 150 EXPORT_SYMBOL(osc_attr_get);
 151
 152 int osc_attr_update(const struct lu_env *env, struct cl_object *obj,
 153                     const struct cl_attr *attr, unsigned valid)
 154 {
 155         struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
 156         struct ost_lvb   *lvb   = &oinfo->loi_lvb;
 157
 158         if (valid & CAT_SIZE)
 159                 lvb->lvb_size = attr->cat_size;
 160         if (valid & CAT_MTIME)
 161                 lvb->lvb_mtime = attr->cat_mtime;
 162         if (valid & CAT_ATIME)
 163                 lvb->lvb_atime = attr->cat_atime;
 164         if (valid & CAT_CTIME)
 165                 lvb->lvb_ctime = attr->cat_ctime;
 166         if (valid & CAT_BLOCKS)
 167                 lvb->lvb_blocks = attr->cat_blocks;
 168         if (valid & CAT_KMS) {
 169                 CDEBUG(D_CACHE, "set kms from %lluto %llu\n",
 170                        oinfo->loi_kms, (__u64)attr->cat_kms);
 171                 loi_kms_set(oinfo, attr->cat_kms);
 172         }
 173         return 0;
 174 }
 175 EXPORT_SYMBOL(osc_attr_update);
 176
 177 int osc_object_glimpse(const struct lu_env *env, const struct cl_object *obj,
 178                        struct ost_lvb *lvb)
 179 {
 180         struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
 181
 182         lvb->lvb_size = oinfo->loi_kms;
 183         lvb->lvb_blocks = oinfo->loi_lvb.lvb_blocks;
 184         return 0;
 185 }
 186 EXPORT_SYMBOL(osc_object_glimpse);
 187
 188 static int osc_object_ast_clear(struct ldlm_lock *lock, void *data)
 189 {
 190         ENTRY;
 191
 192         if (lock->l_ast_data == data)
 193                 lock->l_ast_data = NULL;
 194         RETURN(LDLM_ITER_CONTINUE);
 195 }
 196
 197 static int osc_object_prune(const struct lu_env *env, struct cl_object *obj)
 198 {
 199         struct osc_object       *osc = cl2osc(obj);
 200         struct ldlm_res_id      *resname = &osc_env_info(env)->oti_resname;
 201
 202         /* DLM locks don't hold a reference of osc_object so we have to
 203          * clear it before the object is being destroyed. */
 204         ostid_build_res_name(&osc->oo_oinfo->loi_oi, resname);
 205         ldlm_resource_iterate(osc_export(osc)->exp_obd->obd_namespace, resname,
 206                               osc_object_ast_clear, osc);
 207         return 0;
 208 }
 209
 210 static int osc_object_fiemap(const struct lu_env *env, struct cl_object *obj,
 211                              struct ll_fiemap_info_key *fmkey,
 212                              struct fiemap *fiemap, size_t *buflen)
 213 {
 214         struct obd_export *exp = osc_export(cl2osc(obj));
 215         struct ldlm_res_id resid;
 216         union ldlm_policy_data policy;
 217         struct lustre_handle lockh;
 218         enum ldlm_mode mode = LCK_MINMODE;
 219         struct ptlrpc_request *req;
 220         struct fiemap *reply;
 221         char *tmp;
 222         int rc;
 223         ENTRY;
 224
 225         fmkey->lfik_oa.o_oi = cl2osc(obj)->oo_oinfo->loi_oi;
 226         if (!(fmkey->lfik_fiemap.fm_flags & FIEMAP_FLAG_SYNC))
 227                 goto skip_locking;
 228
 229         policy.l_extent.start = fmkey->lfik_fiemap.fm_start & PAGE_MASK;
 230
 231         if (OBD_OBJECT_EOF - fmkey->lfik_fiemap.fm_length <=
 232             fmkey->lfik_fiemap.fm_start + PAGE_SIZE - 1)
 233                 policy.l_extent.end = OBD_OBJECT_EOF;
 234         else
 235                 policy.l_extent.end = (fmkey->lfik_fiemap.fm_start +
 236                                        fmkey->lfik_fiemap.fm_length +
 237                                        PAGE_SIZE - 1) & PAGE_MASK;
 238
 239         ostid_build_res_name(&fmkey->lfik_oa.o_oi, &resid);
 240         mode = ldlm_lock_match(exp->exp_obd->obd_namespace,
 241                                LDLM_FL_BLOCK_GRANTED | LDLM_FL_LVB_READY,
 242                                &resid, LDLM_EXTENT, &policy,
 243                                LCK_PR | LCK_PW, &lockh, 0);
 244         if (mode) { /* lock is cached on client */
 245                 if (mode != LCK_PR) {
 246                         ldlm_lock_addref(&lockh, LCK_PR);
 247                         ldlm_lock_decref(&lockh, LCK_PW);
 248                 }
 249         } else { /* no cached lock, needs acquire lock on server side */
 250                 fmkey->lfik_oa.o_valid |= OBD_MD_FLFLAGS;
 251                 fmkey->lfik_oa.o_flags |= OBD_FL_SRVLOCK;
 252         }
 253
 254 skip_locking:
 255         req = ptlrpc_request_alloc(class_exp2cliimp(exp),
 256                                    &RQF_OST_GET_INFO_FIEMAP);
 257         if (req == NULL)
 258                 GOTO(drop_lock, rc = -ENOMEM);
 259
 260         req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_KEY, RCL_CLIENT,
 261                              sizeof(*fmkey));
 262         req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_CLIENT,
 263                              *buflen);
 264         req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_SERVER,
 265                              *buflen);
 266
 267         rc = ptlrpc_request_pack(req, LUSTRE_OST_VERSION, OST_GET_INFO);
 268         if (rc != 0) {
 269                 ptlrpc_request_free(req);
 270                 GOTO(drop_lock, rc);
 271         }
 272         tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_KEY);
 273         memcpy(tmp, fmkey, sizeof(*fmkey));
 274         tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_VAL);
 275         memcpy(tmp, fiemap, *buflen);
 276         ptlrpc_request_set_replen(req);
 277
 278         rc = ptlrpc_queue_wait(req);
 279         if (rc != 0)
 280                 GOTO(fini_req, rc);
 281
 282         reply = req_capsule_server_get(&req->rq_pill, &RMF_FIEMAP_VAL);
 283         if (reply == NULL)
 284                 GOTO(fini_req, rc = -EPROTO);
 285
 286         memcpy(fiemap, reply, *buflen);
 287 fini_req:
 288         ptlrpc_req_finished(req);
 289 drop_lock:
 290         if (mode)
 291                 ldlm_lock_decref(&lockh, LCK_PR);
 292         RETURN(rc);
 293 }
 294
 295 void osc_object_set_contended(struct osc_object *obj)
 296 {
 297         obj->oo_contention_time = cfs_time_current();
 298         /* mb(); */
 299         obj->oo_contended = 1;
 300 }
 301
 302 void osc_object_clear_contended(struct osc_object *obj)
 303 {
 304         obj->oo_contended = 0;
 305 }
 306
 307 int osc_object_is_contended(struct osc_object *obj)
 308 {
 309         struct osc_device *dev  = lu2osc_dev(obj->oo_cl.co_lu.lo_dev);
 310         int osc_contention_time = dev->od_contention_time;
 311         cfs_time_t cur_time     = cfs_time_current();
 312         cfs_time_t retry_time;
 313
 314         if (OBD_FAIL_CHECK(OBD_FAIL_OSC_OBJECT_CONTENTION))
 315                 return 1;
 316
 317         if (!obj->oo_contended)
 318                 return 0;
 319
 320         /*
 321          * I like copy-paste. the code is copied from
 322          * ll_file_is_contended.
 323          */
 324         retry_time = cfs_time_add(obj->oo_contention_time,
 325                                   cfs_time_seconds(osc_contention_time));
 326         if (cfs_time_after(cur_time, retry_time)) {
 327                 osc_object_clear_contended(obj);
 328                 return 0;
 329         }
 330         return 1;
 331 }
 332
 333 /**
 334  * Implementation of struct cl_object_operations::coo_req_attr_set() for osc
 335  * layer. osc is responsible for struct obdo::o_id and struct obdo::o_seq
 336  * fields.
 337  */
 338 static void osc_req_attr_set(const struct lu_env *env, struct cl_object *obj,
 339                              struct cl_req_attr *attr)
 340 {
 341         struct lov_oinfo *oinfo;
 342         struct obdo      *oa;
 343         struct ost_lvb   *lvb;
 344         u64               flags = attr->cra_flags;
 345
 346         oinfo   = cl2osc(obj)->oo_oinfo;
 347         lvb     = &oinfo->loi_lvb;
 348         oa      = attr->cra_oa;
 349
 350         if ((flags & OBD_MD_FLMTIME) != 0) {
 351                 oa->o_mtime = lvb->lvb_mtime;
 352                 oa->o_valid |= OBD_MD_FLMTIME;
 353         }
 354         if ((flags & OBD_MD_FLATIME) != 0) {
 355                 oa->o_atime = lvb->lvb_atime;
 356                 oa->o_valid |= OBD_MD_FLATIME;
 357         }
 358         if ((flags & OBD_MD_FLCTIME) != 0) {
 359                 oa->o_ctime = lvb->lvb_ctime;
 360                 oa->o_valid |= OBD_MD_FLCTIME;
 361         }
 362         if (flags & OBD_MD_FLGROUP) {
 363                 ostid_set_seq(&oa->o_oi, ostid_seq(&oinfo->loi_oi));
 364                 oa->o_valid |= OBD_MD_FLGROUP;
 365         }
 366         if (flags & OBD_MD_FLID) {
 367                 int rc;
 368
 369                 rc = ostid_set_id(&oa->o_oi, ostid_id(&oinfo->loi_oi));
 370                 if (rc) {
 371                         CERROR("Bad %llu to set " DOSTID " : rc %d\n",
 372                                (unsigned long long)ostid_id(&oinfo->loi_oi),
 373                                POSTID(&oa->o_oi), rc);
 374                 }
 375                 oa->o_valid |= OBD_MD_FLID;
 376         }
 377         if (flags & OBD_MD_FLHANDLE) {
 378                 struct ldlm_lock *lock;
 379                 struct osc_page *opg;
 380
 381                 opg = osc_cl_page_osc(attr->cra_page, cl2osc(obj));
 382                 lock = osc_dlmlock_at_pgoff(env, cl2osc(obj), osc_index(opg),
 383                                 OSC_DAP_FL_TEST_LOCK | OSC_DAP_FL_CANCELING);
 384                 if (lock == NULL && !opg->ops_srvlock) {
 385                         struct ldlm_resource *res;
 386                         struct ldlm_res_id *resname;
 387
 388                         CL_PAGE_DEBUG(D_ERROR, env, attr->cra_page,
 389                                       "uncovered page!\n");
 390
 391                         resname = &osc_env_info(env)->oti_resname;
 392                         ostid_build_res_name(&oinfo->loi_oi, resname);
 393                         res = ldlm_resource_get(
 394                                 osc_export(cl2osc(obj))->exp_obd->obd_namespace,
 395                                 NULL, resname, LDLM_EXTENT, 0);
 396                         ldlm_resource_dump(D_ERROR, res);
 397
 398                         libcfs_debug_dumpstack(NULL);
 399                         LBUG();
 400                 }
 401
 402                 /* check for lockless io. */
 403                 if (lock != NULL) {
 404                         oa->o_handle = lock->l_remote_handle;
 405                         oa->o_valid |= OBD_MD_FLHANDLE;
 406                         LDLM_LOCK_PUT(lock);
 407                 }
 408         }
 409 }
 410
 411 static const struct cl_object_operations osc_ops = {
 412         .coo_page_init    = osc_page_init,
 413         .coo_lock_init    = osc_lock_init,
 414         .coo_io_init      = osc_io_init,
 415         .coo_attr_get     = osc_attr_get,
 416         .coo_attr_update  = osc_attr_update,
 417         .coo_glimpse      = osc_object_glimpse,
 418         .coo_prune        = osc_object_prune,
 419         .coo_fiemap       = osc_object_fiemap,
 420         .coo_req_attr_set = osc_req_attr_set
 421 };
 422
 423 static const struct lu_object_operations osc_lu_obj_ops = {
 424         .loo_object_init      = osc_object_init,
 425         .loo_object_release   = NULL,
 426         .loo_object_free      = osc_object_free,
 427         .loo_object_print     = osc_object_print,
 428         .loo_object_invariant = NULL
 429 };
 430
 431 struct lu_object *osc_object_alloc(const struct lu_env *env,
 432                                    const struct lu_object_header *unused,
 433                                    struct lu_device *dev)
 434 {
 435         struct osc_object *osc;
 436         struct lu_object  *obj;
 437
 438         OBD_SLAB_ALLOC_PTR_GFP(osc, osc_object_kmem, GFP_NOFS);
 439         if (osc != NULL) {
 440                 obj = osc2lu(osc);
 441                 lu_object_init(obj, NULL, dev);
 442                 osc->oo_cl.co_ops = &osc_ops;
 443                 obj->lo_ops = &osc_lu_obj_ops;
 444         } else
 445                 obj = NULL;
 446         return obj;
 447 }
 448
 449 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc)
 450 {
 451         struct l_wait_info lwi = { 0 };
 452         ENTRY;
 453
 454         CDEBUG(D_INODE, "Invalidate osc object: %p, # of active IOs: %d\n",
 455                osc, atomic_read(&osc->oo_nr_ios));
 456
 457         l_wait_event(osc->oo_io_waitq, atomic_read(&osc->oo_nr_ios) == 0, &lwi);
 458
 459         /* Discard all dirty pages of this object. */
 460         osc_cache_truncate_start(env, osc, 0, NULL);
 461
 462         /* Discard all caching pages */
 463         osc_lock_discard_pages(env, osc, 0, CL_PAGE_EOF, true);
 464
 465         /* Clear ast data of dlm lock. Do this after discarding all pages */
 466         osc_object_prune(env, osc2cl(osc));
 467
 468         RETURN(0);
 469 }
 470 EXPORT_SYMBOL(osc_object_invalidate);
 471 /** @} osc */