4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2015, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * Implementation of cl_object for OSC layer.
34 * Author: Nikita Danilov <nikita.danilov@sun.com>
35 * Author: Jinshan Xiong <jinshan.xiong@intel.com>
38 #define DEBUG_SUBSYSTEM S_OSC
40 #include "osc_cl_internal.h"
46 /*****************************************************************************
52 static struct lu_object *osc2lu(struct osc_object *osc)
54 return &osc->oo_cl.co_lu;
57 static struct osc_object *lu2osc(const struct lu_object *obj)
59 LINVRNT(osc_is_object(obj));
60 return container_of0(obj, struct osc_object, oo_cl.co_lu);
63 /*****************************************************************************
69 static int osc_object_init(const struct lu_env *env, struct lu_object *obj,
70 const struct lu_object_conf *conf)
72 struct osc_object *osc = lu2osc(obj);
73 const struct cl_object_conf *cconf = lu2cl_conf(conf);
75 osc->oo_oinfo = cconf->u.coc_oinfo;
76 INIT_LIST_HEAD(&osc->oo_ready_item);
77 INIT_LIST_HEAD(&osc->oo_hp_ready_item);
78 INIT_LIST_HEAD(&osc->oo_write_item);
79 INIT_LIST_HEAD(&osc->oo_read_item);
81 atomic_set(&osc->oo_nr_ios, 0);
82 init_waitqueue_head(&osc->oo_io_waitq);
84 osc->oo_root.rb_node = NULL;
85 INIT_LIST_HEAD(&osc->oo_hp_exts);
86 INIT_LIST_HEAD(&osc->oo_urgent_exts);
87 INIT_LIST_HEAD(&osc->oo_rpc_exts);
88 INIT_LIST_HEAD(&osc->oo_reading_exts);
89 atomic_set(&osc->oo_nr_reads, 0);
90 atomic_set(&osc->oo_nr_writes, 0);
91 spin_lock_init(&osc->oo_lock);
92 spin_lock_init(&osc->oo_tree_lock);
93 spin_lock_init(&osc->oo_ol_spin);
94 INIT_LIST_HEAD(&osc->oo_ol_list);
96 cl_object_page_init(lu2cl(obj), sizeof(struct osc_page));
101 static void osc_object_free(const struct lu_env *env, struct lu_object *obj)
103 struct osc_object *osc = lu2osc(obj);
105 LASSERT(list_empty(&osc->oo_ready_item));
106 LASSERT(list_empty(&osc->oo_hp_ready_item));
107 LASSERT(list_empty(&osc->oo_write_item));
108 LASSERT(list_empty(&osc->oo_read_item));
110 LASSERT(!osc->oo_root.rb_node);
111 LASSERT(list_empty(&osc->oo_hp_exts));
112 LASSERT(list_empty(&osc->oo_urgent_exts));
113 LASSERT(list_empty(&osc->oo_rpc_exts));
114 LASSERT(list_empty(&osc->oo_reading_exts));
115 LASSERT(atomic_read(&osc->oo_nr_reads) == 0);
116 LASSERT(atomic_read(&osc->oo_nr_writes) == 0);
117 LASSERT(list_empty(&osc->oo_ol_list));
118 LASSERT(!atomic_read(&osc->oo_nr_ios));
121 kmem_cache_free(osc_object_kmem, osc);
124 int osc_lvb_print(const struct lu_env *env, void *cookie,
125 lu_printer_t p, const struct ost_lvb *lvb)
127 return (*p)(env, cookie, "size: %llu mtime: %llu atime: %llu ctime: %llu blocks: %llu",
128 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
129 lvb->lvb_ctime, lvb->lvb_blocks);
132 static int osc_object_print(const struct lu_env *env, void *cookie,
133 lu_printer_t p, const struct lu_object *obj)
135 struct osc_object *osc = lu2osc(obj);
136 struct lov_oinfo *oinfo = osc->oo_oinfo;
137 struct osc_async_rc *ar = &oinfo->loi_ar;
139 (*p)(env, cookie, "id: " DOSTID " idx: %d gen: %d kms_valid: %u kms %llu rc: %d force_sync: %d min_xid: %llu ",
140 POSTID(&oinfo->loi_oi), oinfo->loi_ost_idx,
141 oinfo->loi_ost_gen, oinfo->loi_kms_valid, oinfo->loi_kms,
142 ar->ar_rc, ar->ar_force_sync, ar->ar_min_xid);
143 osc_lvb_print(env, cookie, p, &oinfo->loi_lvb);
147 static int osc_attr_get(const struct lu_env *env, struct cl_object *obj,
148 struct cl_attr *attr)
150 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
152 cl_lvb2attr(attr, &oinfo->loi_lvb);
153 attr->cat_kms = oinfo->loi_kms_valid ? oinfo->loi_kms : 0;
157 static int osc_attr_update(const struct lu_env *env, struct cl_object *obj,
158 const struct cl_attr *attr, unsigned int valid)
160 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
161 struct ost_lvb *lvb = &oinfo->loi_lvb;
163 if (valid & CAT_SIZE)
164 lvb->lvb_size = attr->cat_size;
165 if (valid & CAT_MTIME)
166 lvb->lvb_mtime = attr->cat_mtime;
167 if (valid & CAT_ATIME)
168 lvb->lvb_atime = attr->cat_atime;
169 if (valid & CAT_CTIME)
170 lvb->lvb_ctime = attr->cat_ctime;
171 if (valid & CAT_BLOCKS)
172 lvb->lvb_blocks = attr->cat_blocks;
173 if (valid & CAT_KMS) {
174 CDEBUG(D_CACHE, "set kms from %llu to %llu\n",
175 oinfo->loi_kms, (__u64)attr->cat_kms);
176 loi_kms_set(oinfo, attr->cat_kms);
181 static int osc_object_glimpse(const struct lu_env *env,
182 const struct cl_object *obj, struct ost_lvb *lvb)
184 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
186 lvb->lvb_size = oinfo->loi_kms;
187 lvb->lvb_blocks = oinfo->loi_lvb.lvb_blocks;
191 static int osc_object_ast_clear(struct ldlm_lock *lock, void *data)
193 if (lock->l_ast_data == data)
194 lock->l_ast_data = NULL;
195 return LDLM_ITER_CONTINUE;
198 static int osc_object_prune(const struct lu_env *env, struct cl_object *obj)
200 struct osc_object *osc = cl2osc(obj);
201 struct ldlm_res_id *resname = &osc_env_info(env)->oti_resname;
203 /* DLM locks don't hold a reference of osc_object so we have to
204 * clear it before the object is being destroyed.
206 ostid_build_res_name(&osc->oo_oinfo->loi_oi, resname);
207 ldlm_resource_iterate(osc_export(osc)->exp_obd->obd_namespace, resname,
208 osc_object_ast_clear, osc);
212 static int osc_object_fiemap(const struct lu_env *env, struct cl_object *obj,
213 struct ll_fiemap_info_key *fmkey,
214 struct fiemap *fiemap, size_t *buflen)
216 struct obd_export *exp = osc_export(cl2osc(obj));
217 union ldlm_policy_data policy;
218 struct ptlrpc_request *req;
219 struct lustre_handle lockh;
220 struct ldlm_res_id resid;
221 enum ldlm_mode mode = 0;
222 struct fiemap *reply;
226 fmkey->lfik_oa.o_oi = cl2osc(obj)->oo_oinfo->loi_oi;
227 if (!(fmkey->lfik_fiemap.fm_flags & FIEMAP_FLAG_SYNC))
230 policy.l_extent.start = fmkey->lfik_fiemap.fm_start & PAGE_MASK;
232 if (OBD_OBJECT_EOF - fmkey->lfik_fiemap.fm_length <=
233 fmkey->lfik_fiemap.fm_start + PAGE_SIZE - 1)
234 policy.l_extent.end = OBD_OBJECT_EOF;
236 policy.l_extent.end = (fmkey->lfik_fiemap.fm_start +
237 fmkey->lfik_fiemap.fm_length +
238 PAGE_SIZE - 1) & PAGE_MASK;
240 ostid_build_res_name(&fmkey->lfik_oa.o_oi, &resid);
241 mode = ldlm_lock_match(exp->exp_obd->obd_namespace,
242 LDLM_FL_BLOCK_GRANTED | LDLM_FL_LVB_READY,
243 &resid, LDLM_EXTENT, &policy,
244 LCK_PR | LCK_PW, &lockh, 0);
245 if (mode) { /* lock is cached on client */
246 if (mode != LCK_PR) {
247 ldlm_lock_addref(&lockh, LCK_PR);
248 ldlm_lock_decref(&lockh, LCK_PW);
250 } else { /* no cached lock, needs acquire lock on server side */
251 fmkey->lfik_oa.o_valid |= OBD_MD_FLFLAGS;
252 fmkey->lfik_oa.o_flags |= OBD_FL_SRVLOCK;
256 req = ptlrpc_request_alloc(class_exp2cliimp(exp),
257 &RQF_OST_GET_INFO_FIEMAP);
263 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_KEY, RCL_CLIENT,
265 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_CLIENT,
267 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_SERVER,
270 rc = ptlrpc_request_pack(req, LUSTRE_OST_VERSION, OST_GET_INFO);
272 ptlrpc_request_free(req);
275 tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_KEY);
276 memcpy(tmp, fmkey, sizeof(*fmkey));
277 tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_VAL);
278 memcpy(tmp, fiemap, *buflen);
279 ptlrpc_request_set_replen(req);
281 rc = ptlrpc_queue_wait(req);
285 reply = req_capsule_server_get(&req->rq_pill, &RMF_FIEMAP_VAL);
291 memcpy(fiemap, reply, *buflen);
293 ptlrpc_req_finished(req);
296 ldlm_lock_decref(&lockh, LCK_PR);
300 void osc_object_set_contended(struct osc_object *obj)
302 obj->oo_contention_time = cfs_time_current();
304 obj->oo_contended = 1;
307 void osc_object_clear_contended(struct osc_object *obj)
309 obj->oo_contended = 0;
312 int osc_object_is_contended(struct osc_object *obj)
314 struct osc_device *dev = lu2osc_dev(obj->oo_cl.co_lu.lo_dev);
315 int osc_contention_time = dev->od_contention_time;
316 unsigned long cur_time = cfs_time_current();
317 unsigned long retry_time;
319 if (OBD_FAIL_CHECK(OBD_FAIL_OSC_OBJECT_CONTENTION))
322 if (!obj->oo_contended)
326 * I like copy-paste. the code is copied from
327 * ll_file_is_contended.
329 retry_time = cfs_time_add(obj->oo_contention_time,
330 cfs_time_seconds(osc_contention_time));
331 if (cfs_time_after(cur_time, retry_time)) {
332 osc_object_clear_contended(obj);
339 * Implementation of struct cl_object_operations::coo_req_attr_set() for osc
340 * layer. osc is responsible for struct obdo::o_id and struct obdo::o_seq
343 static void osc_req_attr_set(const struct lu_env *env, struct cl_object *obj,
344 struct cl_req_attr *attr)
346 u64 flags = attr->cra_flags;
347 struct lov_oinfo *oinfo;
351 oinfo = cl2osc(obj)->oo_oinfo;
352 lvb = &oinfo->loi_lvb;
355 if (flags & OBD_MD_FLMTIME) {
356 oa->o_mtime = lvb->lvb_mtime;
357 oa->o_valid |= OBD_MD_FLMTIME;
359 if (flags & OBD_MD_FLATIME) {
360 oa->o_atime = lvb->lvb_atime;
361 oa->o_valid |= OBD_MD_FLATIME;
363 if (flags & OBD_MD_FLCTIME) {
364 oa->o_ctime = lvb->lvb_ctime;
365 oa->o_valid |= OBD_MD_FLCTIME;
367 if (flags & OBD_MD_FLGROUP) {
368 ostid_set_seq(&oa->o_oi, ostid_seq(&oinfo->loi_oi));
369 oa->o_valid |= OBD_MD_FLGROUP;
371 if (flags & OBD_MD_FLID) {
374 rc = ostid_set_id(&oa->o_oi, ostid_id(&oinfo->loi_oi));
376 CERROR("Bad %llu to set " DOSTID " : rc %d\n",
377 (unsigned long long)ostid_id(&oinfo->loi_oi),
378 POSTID(&oa->o_oi), rc);
380 oa->o_valid |= OBD_MD_FLID;
382 if (flags & OBD_MD_FLHANDLE) {
383 struct ldlm_lock *lock;
384 struct osc_page *opg;
386 opg = osc_cl_page_osc(attr->cra_page, cl2osc(obj));
387 lock = osc_dlmlock_at_pgoff(env, cl2osc(obj), osc_index(opg),
388 OSC_DAP_FL_TEST_LOCK | OSC_DAP_FL_CANCELING);
389 if (!lock && !opg->ops_srvlock) {
390 struct ldlm_resource *res;
391 struct ldlm_res_id *resname;
393 CL_PAGE_DEBUG(D_ERROR, env, attr->cra_page,
394 "uncovered page!\n");
396 resname = &osc_env_info(env)->oti_resname;
397 ostid_build_res_name(&oinfo->loi_oi, resname);
398 res = ldlm_resource_get(
399 osc_export(cl2osc(obj))->exp_obd->obd_namespace,
400 NULL, resname, LDLM_EXTENT, 0);
401 ldlm_resource_dump(D_ERROR, res);
406 /* check for lockless io. */
408 oa->o_handle = lock->l_remote_handle;
409 oa->o_valid |= OBD_MD_FLHANDLE;
415 static const struct cl_object_operations osc_ops = {
416 .coo_page_init = osc_page_init,
417 .coo_lock_init = osc_lock_init,
418 .coo_io_init = osc_io_init,
419 .coo_attr_get = osc_attr_get,
420 .coo_attr_update = osc_attr_update,
421 .coo_glimpse = osc_object_glimpse,
422 .coo_prune = osc_object_prune,
423 .coo_fiemap = osc_object_fiemap,
424 .coo_req_attr_set = osc_req_attr_set
427 static const struct lu_object_operations osc_lu_obj_ops = {
428 .loo_object_init = osc_object_init,
429 .loo_object_release = NULL,
430 .loo_object_free = osc_object_free,
431 .loo_object_print = osc_object_print,
432 .loo_object_invariant = NULL
435 struct lu_object *osc_object_alloc(const struct lu_env *env,
436 const struct lu_object_header *unused,
437 struct lu_device *dev)
439 struct osc_object *osc;
440 struct lu_object *obj;
442 osc = kmem_cache_zalloc(osc_object_kmem, GFP_NOFS);
445 lu_object_init(obj, NULL, dev);
446 osc->oo_cl.co_ops = &osc_ops;
447 obj->lo_ops = &osc_lu_obj_ops;
454 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc)
456 struct l_wait_info lwi = { 0 };
458 CDEBUG(D_INODE, "Invalidate osc object: %p, # of active IOs: %d\n",
459 osc, atomic_read(&osc->oo_nr_ios));
461 l_wait_event(osc->oo_io_waitq, !atomic_read(&osc->oo_nr_ios), &lwi);
463 /* Discard all dirty pages of this object. */
464 osc_cache_truncate_start(env, osc, 0, NULL);
466 /* Discard all caching pages */
467 osc_lock_discard_pages(env, osc, 0, CL_PAGE_EOF, CLM_WRITE);
469 /* Clear ast data of dlm lock. Do this after discarding all pages */
470 osc_object_prune(env, osc2cl(osc));