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, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * Implementation of cl_object for OSC layer.
33 * Author: Nikita Danilov <nikita.danilov@sun.com>
34 * Author: Jinshan Xiong <jinshan.xiong@intel.com>
37 #define DEBUG_SUBSYSTEM S_OSC
38 #include <lustre_osc.h>
40 #include "osc_internal.h"
46 /*****************************************************************************
51 static void osc_obj_build_res_name(struct osc_object *osc,
52 struct ldlm_res_id *resname)
54 ostid_build_res_name(&osc->oo_oinfo->loi_oi, resname);
57 static const struct osc_object_operations osc_object_ops = {
58 .oto_build_res_name = osc_obj_build_res_name,
59 .oto_dlmlock_at_pgoff = osc_obj_dlmlock_at_pgoff,
62 int osc_object_init(const struct lu_env *env, struct lu_object *obj,
63 const struct lu_object_conf *conf)
65 struct osc_object *osc = lu2osc(obj);
66 const struct cl_object_conf *cconf = lu2cl_conf(conf);
68 osc->oo_oinfo = cconf->u.coc_oinfo;
69 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
70 mutex_init(&osc->oo_debug_mutex);
72 INIT_LIST_HEAD(&osc->oo_ready_item);
73 INIT_LIST_HEAD(&osc->oo_hp_ready_item);
74 INIT_LIST_HEAD(&osc->oo_write_item);
75 INIT_LIST_HEAD(&osc->oo_read_item);
77 osc->oo_root.rb_node = NULL;
78 INIT_LIST_HEAD(&osc->oo_hp_exts);
79 INIT_LIST_HEAD(&osc->oo_urgent_exts);
80 INIT_LIST_HEAD(&osc->oo_full_exts);
81 INIT_LIST_HEAD(&osc->oo_reading_exts);
82 atomic_set(&osc->oo_nr_reads, 0);
83 atomic_set(&osc->oo_nr_writes, 0);
84 spin_lock_init(&osc->oo_lock);
85 spin_lock_init(&osc->oo_tree_lock);
86 spin_lock_init(&osc->oo_ol_spin);
87 INIT_LIST_HEAD(&osc->oo_ol_list);
89 atomic_set(&osc->oo_nr_ios, 0);
90 init_waitqueue_head(&osc->oo_io_waitq);
92 LASSERT(osc->oo_obj_ops != NULL);
94 cl_object_page_init(lu2cl(obj), sizeof(struct osc_page));
98 EXPORT_SYMBOL(osc_object_init);
100 void osc_object_free(const struct lu_env *env, struct lu_object *obj)
102 struct osc_object *osc = lu2osc(obj);
104 LASSERT(list_empty(&osc->oo_ready_item));
105 LASSERT(list_empty(&osc->oo_hp_ready_item));
106 LASSERT(list_empty(&osc->oo_write_item));
107 LASSERT(list_empty(&osc->oo_read_item));
109 LASSERT(osc->oo_root.rb_node == NULL);
110 LASSERT(list_empty(&osc->oo_hp_exts));
111 LASSERT(list_empty(&osc->oo_urgent_exts));
112 LASSERT(list_empty(&osc->oo_full_exts));
113 LASSERT(list_empty(&osc->oo_reading_exts));
114 LASSERT(atomic_read(&osc->oo_nr_reads) == 0);
115 LASSERT(atomic_read(&osc->oo_nr_writes) == 0);
116 LASSERT(list_empty(&osc->oo_ol_list));
117 LASSERT(atomic_read(&osc->oo_nr_ios) == 0);
120 /* osc doen't contain an lu_object_header, so we don't need call_rcu */
121 OBD_SLAB_FREE_PTR(osc, osc_object_kmem);
123 EXPORT_SYMBOL(osc_object_free);
125 int osc_lvb_print(const struct lu_env *env, void *cookie,
126 lu_printer_t p, const struct ost_lvb *lvb)
128 return (*p)(env, cookie, "size: %llu mtime: %llu atime: %llu "
129 "ctime: %llu blocks: %llu",
130 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
131 lvb->lvb_ctime, lvb->lvb_blocks);
133 EXPORT_SYMBOL(osc_lvb_print);
135 int osc_object_print(const struct lu_env *env, void *cookie,
136 lu_printer_t p, const struct lu_object *obj)
138 struct osc_object *osc = lu2osc(obj);
139 struct lov_oinfo *oinfo = osc->oo_oinfo;
140 struct osc_async_rc *ar = &oinfo->loi_ar;
142 (*p)(env, cookie, "id: "DOSTID" "
143 "idx: %d gen: %d kms_valid: %u kms %llu "
144 "rc: %d force_sync: %d min_xid: %llu ",
145 POSTID(&oinfo->loi_oi), oinfo->loi_ost_idx,
146 oinfo->loi_ost_gen, oinfo->loi_kms_valid, oinfo->loi_kms,
147 ar->ar_rc, ar->ar_force_sync, ar->ar_min_xid);
148 osc_lvb_print(env, cookie, p, &oinfo->loi_lvb);
151 EXPORT_SYMBOL(osc_object_print);
154 int osc_attr_get(const struct lu_env *env, struct cl_object *obj,
155 struct cl_attr *attr)
157 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
159 cl_lvb2attr(attr, &oinfo->loi_lvb);
160 attr->cat_kms = oinfo->loi_kms_valid ? oinfo->loi_kms : 0;
163 EXPORT_SYMBOL(osc_attr_get);
165 int osc_attr_update(const struct lu_env *env, struct cl_object *obj,
166 const struct cl_attr *attr, unsigned valid)
168 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
169 struct ost_lvb *lvb = &oinfo->loi_lvb;
171 if (valid & CAT_SIZE)
172 lvb->lvb_size = attr->cat_size;
173 if (valid & CAT_MTIME)
174 lvb->lvb_mtime = attr->cat_mtime;
175 if (valid & CAT_ATIME)
176 lvb->lvb_atime = attr->cat_atime;
177 if (valid & CAT_CTIME)
178 lvb->lvb_ctime = attr->cat_ctime;
179 if (valid & CAT_BLOCKS)
180 lvb->lvb_blocks = attr->cat_blocks;
181 if (valid & CAT_KMS) {
182 CDEBUG(D_CACHE, "set kms from %lluto %llu\n",
183 oinfo->loi_kms, (__u64)attr->cat_kms);
184 loi_kms_set(oinfo, attr->cat_kms);
188 EXPORT_SYMBOL(osc_attr_update);
190 int osc_object_glimpse(const struct lu_env *env, const struct cl_object *obj,
193 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
195 lvb->lvb_size = oinfo->loi_kms;
196 lvb->lvb_blocks = oinfo->loi_lvb.lvb_blocks;
199 EXPORT_SYMBOL(osc_object_glimpse);
201 static int osc_object_ast_clear(struct ldlm_lock *lock, void *data)
203 struct osc_object *osc = (struct osc_object *)data;
204 struct ost_lvb *lvb = lock->l_lvb_data;
205 struct lov_oinfo *oinfo;
208 if (lock->l_ast_data == data) {
209 lock->l_ast_data = NULL;
211 LASSERT(osc != NULL);
212 LASSERT(osc->oo_oinfo != NULL);
213 LASSERT(lvb != NULL);
215 /* Updates lvb in lock by the cached oinfo */
216 oinfo = osc->oo_oinfo;
218 LDLM_DEBUG(lock, "update lock size %llu blocks %llu [cma]time: "
219 "%llu %llu %llu by oinfo size %llu blocks %llu "
220 "[cma]time %llu %llu %llu", lvb->lvb_size,
221 lvb->lvb_blocks, lvb->lvb_ctime, lvb->lvb_mtime,
222 lvb->lvb_atime, oinfo->loi_lvb.lvb_size,
223 oinfo->loi_lvb.lvb_blocks, oinfo->loi_lvb.lvb_ctime,
224 oinfo->loi_lvb.lvb_mtime, oinfo->loi_lvb.lvb_atime);
225 LASSERTF(oinfo->loi_lvb.lvb_size >= oinfo->loi_kms,
226 "lvb_size %#llx, loi_kms %#llx\n",
227 oinfo->loi_lvb.lvb_size, oinfo->loi_kms);
229 cl_object_attr_lock(&osc->oo_cl);
230 memcpy(lvb, &oinfo->loi_lvb, sizeof(oinfo->loi_lvb));
231 cl_object_attr_unlock(&osc->oo_cl);
232 ldlm_clear_lvb_cached(lock);
234 RETURN(LDLM_ITER_CONTINUE);
237 int osc_object_prune(const struct lu_env *env, struct cl_object *obj)
239 struct osc_object *osc = cl2osc(obj);
240 struct ldlm_res_id *resname = &osc_env_info(env)->oti_resname;
242 /* DLM locks don't hold a reference of osc_object so we have to
243 * clear it before the object is being destroyed. */
244 osc_build_res_name(osc, resname);
245 ldlm_resource_iterate(osc_export(osc)->exp_obd->obd_namespace, resname,
246 osc_object_ast_clear, osc);
249 EXPORT_SYMBOL(osc_object_prune);
251 static int osc_object_fiemap(const struct lu_env *env, struct cl_object *obj,
252 struct ll_fiemap_info_key *fmkey,
253 struct fiemap *fiemap, size_t *buflen)
255 struct obd_export *exp = osc_export(cl2osc(obj));
256 struct ldlm_res_id resid;
257 union ldlm_policy_data policy;
258 struct lustre_handle lockh;
259 enum ldlm_mode mode = LCK_MINMODE;
260 struct ptlrpc_request *req;
261 struct fiemap *reply;
266 fmkey->lfik_oa.o_oi = cl2osc(obj)->oo_oinfo->loi_oi;
267 if (!(fmkey->lfik_fiemap.fm_flags & FIEMAP_FLAG_SYNC))
270 policy.l_extent.start = fmkey->lfik_fiemap.fm_start & PAGE_MASK;
272 if (OBD_OBJECT_EOF - fmkey->lfik_fiemap.fm_length <=
273 fmkey->lfik_fiemap.fm_start + PAGE_SIZE - 1)
274 policy.l_extent.end = OBD_OBJECT_EOF;
276 policy.l_extent.end = (fmkey->lfik_fiemap.fm_start +
277 fmkey->lfik_fiemap.fm_length +
278 PAGE_SIZE - 1) & PAGE_MASK;
280 ostid_build_res_name(&fmkey->lfik_oa.o_oi, &resid);
281 mode = ldlm_lock_match(exp->exp_obd->obd_namespace,
282 LDLM_FL_BLOCK_GRANTED | LDLM_FL_LVB_READY,
283 &resid, LDLM_EXTENT, &policy,
284 LCK_PR | LCK_PW, &lockh);
285 if (mode) { /* lock is cached on client */
286 if (mode != LCK_PR) {
287 ldlm_lock_addref(&lockh, LCK_PR);
288 ldlm_lock_decref(&lockh, LCK_PW);
290 } else { /* no cached lock, needs acquire lock on server side */
291 fmkey->lfik_oa.o_valid |= OBD_MD_FLFLAGS;
292 fmkey->lfik_oa.o_flags |= OBD_FL_SRVLOCK;
296 req = ptlrpc_request_alloc(class_exp2cliimp(exp),
297 &RQF_OST_GET_INFO_FIEMAP);
299 GOTO(drop_lock, rc = -ENOMEM);
301 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_KEY, RCL_CLIENT,
303 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_CLIENT,
305 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_SERVER,
308 rc = ptlrpc_request_pack(req, LUSTRE_OST_VERSION, OST_GET_INFO);
310 ptlrpc_request_free(req);
313 tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_KEY);
314 memcpy(tmp, fmkey, sizeof(*fmkey));
315 tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_VAL);
316 memcpy(tmp, fiemap, *buflen);
317 ptlrpc_request_set_replen(req);
319 rc = ptlrpc_queue_wait(req);
323 reply = req_capsule_server_get(&req->rq_pill, &RMF_FIEMAP_VAL);
325 GOTO(fini_req, rc = -EPROTO);
327 memcpy(fiemap, reply, *buflen);
329 ptlrpc_req_finished(req);
332 ldlm_lock_decref(&lockh, LCK_PR);
337 * Implementation of struct cl_object_operations::coo_req_attr_set() for osc
338 * layer. osc is responsible for struct obdo::o_id and struct obdo::o_seq
341 static void osc_req_attr_set(const struct lu_env *env, struct cl_object *obj,
342 struct cl_req_attr *attr)
344 struct lov_oinfo *oinfo;
347 u64 flags = attr->cra_flags;
349 oinfo = cl2osc(obj)->oo_oinfo;
350 lvb = &oinfo->loi_lvb;
353 if ((flags & OBD_MD_FLMTIME) != 0) {
354 oa->o_mtime = lvb->lvb_mtime;
355 oa->o_valid |= OBD_MD_FLMTIME;
358 * I don't understand this part, what for OSC resets atime just
359 * set by VVP layer to 0 so that OST gets 0 instead of actual
360 * atime, bzzz. please inspect this place with extra care.
362 if ((flags & OBD_MD_FLATIME) && lvb->lvb_atime > oa->o_atime) {
363 oa->o_atime = lvb->lvb_atime;
364 oa->o_valid |= OBD_MD_FLATIME;
366 if ((flags & OBD_MD_FLCTIME) != 0) {
367 oa->o_ctime = lvb->lvb_ctime;
368 oa->o_valid |= OBD_MD_FLCTIME;
370 if (flags & OBD_MD_FLGROUP) {
371 ostid_set_seq(&oa->o_oi, ostid_seq(&oinfo->loi_oi));
372 oa->o_valid |= OBD_MD_FLGROUP;
374 if (flags & OBD_MD_FLID) {
377 rc = ostid_set_id(&oa->o_oi, ostid_id(&oinfo->loi_oi));
379 CERROR("Bad %llu to set " DOSTID " : rc %d\n",
380 (unsigned long long)ostid_id(&oinfo->loi_oi),
381 POSTID(&oa->o_oi), rc);
383 oa->o_valid |= OBD_MD_FLID;
385 if (flags & OBD_MD_FLHANDLE) {
386 struct ldlm_lock *lock;
387 struct osc_page *opg;
389 opg = osc_cl_page_osc(attr->cra_page, cl2osc(obj));
390 lock = osc_dlmlock_at_pgoff(env, cl2osc(obj), osc_index(opg),
391 OSC_DAP_FL_TEST_LOCK | OSC_DAP_FL_CANCELING);
392 if (lock == NULL && !opg->ops_srvlock) {
393 struct ldlm_resource *res;
394 struct ldlm_res_id *resname;
396 CL_PAGE_DEBUG(D_ERROR, env, attr->cra_page,
397 "uncovered page!\n");
399 resname = &osc_env_info(env)->oti_resname;
400 ostid_build_res_name(&oinfo->loi_oi, resname);
401 res = ldlm_resource_get(osc_export(cl2osc(obj))->
402 exp_obd->obd_namespace,
403 resname, LDLM_EXTENT, 0);
405 CERROR("No lock resource\n");
407 ldlm_resource_dump(D_ERROR, res);
409 libcfs_debug_dumpstack(NULL);
413 /* check for lockless io. */
415 oa->o_handle = lock->l_remote_handle;
416 oa->o_valid |= OBD_MD_FLHANDLE;
422 static const struct cl_object_operations osc_ops = {
423 .coo_page_init = osc_page_init,
424 .coo_lock_init = osc_lock_init,
425 .coo_io_init = osc_io_init,
426 .coo_attr_get = osc_attr_get,
427 .coo_attr_update = osc_attr_update,
428 .coo_glimpse = osc_object_glimpse,
429 .coo_prune = osc_object_prune,
430 .coo_fiemap = osc_object_fiemap,
431 .coo_req_attr_set = osc_req_attr_set
434 static const struct lu_object_operations osc_lu_obj_ops = {
435 .loo_object_init = osc_object_init,
436 .loo_object_release = NULL,
437 .loo_object_free = osc_object_free,
438 .loo_object_print = osc_object_print,
439 .loo_object_invariant = NULL
442 struct lu_object *osc_object_alloc(const struct lu_env *env,
443 const struct lu_object_header *unused,
444 struct lu_device *dev)
446 struct osc_object *osc;
447 struct lu_object *obj;
449 OBD_SLAB_ALLOC_PTR_GFP(osc, osc_object_kmem, GFP_NOFS);
452 lu_object_init(obj, NULL, dev);
453 osc->oo_cl.co_ops = &osc_ops;
454 obj->lo_ops = &osc_lu_obj_ops;
455 osc->oo_obj_ops = &osc_object_ops;
461 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc)
465 CDEBUG(D_INODE, "Invalidate osc object: %p, # of active IOs: %d\n",
466 osc, atomic_read(&osc->oo_nr_ios));
468 wait_event_idle(osc->oo_io_waitq, atomic_read(&osc->oo_nr_ios) == 0);
470 /* Discard all dirty pages of this object. */
471 osc_cache_truncate_start(env, osc, 0, NULL);
473 /* Discard all caching pages */
474 osc_lock_discard_pages(env, osc, 0, CL_PAGE_EOF, true);
476 /* Clear ast data of dlm lock. Do this after discarding all pages */
477 cl_object_prune(env, osc2cl(osc));
481 EXPORT_SYMBOL(osc_object_invalidate);