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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Implementation of cl_object for OSC layer.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
39 * Author: Jinshan Xiong <jinshan.xiong@intel.com>
42 #define DEBUG_SUBSYSTEM S_OSC
44 #include "osc_cl_internal.h"
50 /*****************************************************************************
56 static struct lu_object *osc2lu(struct osc_object *osc)
58 return &osc->oo_cl.co_lu;
61 static struct osc_object *lu2osc(const struct lu_object *obj)
63 LINVRNT(osc_is_object(obj));
64 return container_of0(obj, struct osc_object, oo_cl.co_lu);
67 /*****************************************************************************
73 static int osc_object_init(const struct lu_env *env, struct lu_object *obj,
74 const struct lu_object_conf *conf)
76 struct osc_object *osc = lu2osc(obj);
77 const struct cl_object_conf *cconf = lu2cl_conf(conf);
80 osc->oo_oinfo = cconf->u.coc_oinfo;
81 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
82 mutex_init(&osc->oo_debug_mutex);
84 spin_lock_init(&osc->oo_seatbelt);
85 for (i = 0; i < CRT_NR; ++i)
86 INIT_LIST_HEAD(&osc->oo_inflight[i]);
88 INIT_LIST_HEAD(&osc->oo_ready_item);
89 INIT_LIST_HEAD(&osc->oo_hp_ready_item);
90 INIT_LIST_HEAD(&osc->oo_write_item);
91 INIT_LIST_HEAD(&osc->oo_read_item);
93 osc->oo_root.rb_node = NULL;
94 INIT_LIST_HEAD(&osc->oo_hp_exts);
95 INIT_LIST_HEAD(&osc->oo_urgent_exts);
96 INIT_LIST_HEAD(&osc->oo_rpc_exts);
97 INIT_LIST_HEAD(&osc->oo_reading_exts);
98 atomic_set(&osc->oo_nr_reads, 0);
99 atomic_set(&osc->oo_nr_writes, 0);
100 spin_lock_init(&osc->oo_lock);
101 spin_lock_init(&osc->oo_tree_lock);
102 spin_lock_init(&osc->oo_ol_spin);
103 INIT_LIST_HEAD(&osc->oo_ol_list);
105 cl_object_page_init(lu2cl(obj), sizeof(struct osc_page));
110 static void osc_object_free(const struct lu_env *env, struct lu_object *obj)
112 struct osc_object *osc = lu2osc(obj);
115 for (i = 0; i < CRT_NR; ++i)
116 LASSERT(list_empty(&osc->oo_inflight[i]));
118 LASSERT(list_empty(&osc->oo_ready_item));
119 LASSERT(list_empty(&osc->oo_hp_ready_item));
120 LASSERT(list_empty(&osc->oo_write_item));
121 LASSERT(list_empty(&osc->oo_read_item));
123 LASSERT(osc->oo_root.rb_node == NULL);
124 LASSERT(list_empty(&osc->oo_hp_exts));
125 LASSERT(list_empty(&osc->oo_urgent_exts));
126 LASSERT(list_empty(&osc->oo_rpc_exts));
127 LASSERT(list_empty(&osc->oo_reading_exts));
128 LASSERT(atomic_read(&osc->oo_nr_reads) == 0);
129 LASSERT(atomic_read(&osc->oo_nr_writes) == 0);
130 LASSERT(list_empty(&osc->oo_ol_list));
133 OBD_SLAB_FREE_PTR(osc, osc_object_kmem);
136 int osc_lvb_print(const struct lu_env *env, void *cookie,
137 lu_printer_t p, const struct ost_lvb *lvb)
139 return (*p)(env, cookie, "size: "LPU64" mtime: "LPU64" atime: "LPU64" "
140 "ctime: "LPU64" blocks: "LPU64,
141 lvb->lvb_size, lvb->lvb_mtime, lvb->lvb_atime,
142 lvb->lvb_ctime, lvb->lvb_blocks);
145 static int osc_object_print(const struct lu_env *env, void *cookie,
146 lu_printer_t p, const struct lu_object *obj)
148 struct osc_object *osc = lu2osc(obj);
149 struct lov_oinfo *oinfo = osc->oo_oinfo;
150 struct osc_async_rc *ar = &oinfo->loi_ar;
152 (*p)(env, cookie, "id: "DOSTID" "
153 "idx: %d gen: %d kms_valid: %u kms "LPU64" "
154 "rc: %d force_sync: %d min_xid: "LPU64" ",
155 POSTID(&oinfo->loi_oi), oinfo->loi_ost_idx,
156 oinfo->loi_ost_gen, oinfo->loi_kms_valid, oinfo->loi_kms,
157 ar->ar_rc, ar->ar_force_sync, ar->ar_min_xid);
158 osc_lvb_print(env, cookie, p, &oinfo->loi_lvb);
163 static int osc_attr_get(const struct lu_env *env, struct cl_object *obj,
164 struct cl_attr *attr)
166 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
168 cl_lvb2attr(attr, &oinfo->loi_lvb);
169 attr->cat_kms = oinfo->loi_kms_valid ? oinfo->loi_kms : 0;
173 static int osc_attr_update(const struct lu_env *env, struct cl_object *obj,
174 const struct cl_attr *attr, unsigned valid)
176 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
177 struct ost_lvb *lvb = &oinfo->loi_lvb;
179 if (valid & CAT_SIZE)
180 lvb->lvb_size = attr->cat_size;
181 if (valid & CAT_MTIME)
182 lvb->lvb_mtime = attr->cat_mtime;
183 if (valid & CAT_ATIME)
184 lvb->lvb_atime = attr->cat_atime;
185 if (valid & CAT_CTIME)
186 lvb->lvb_ctime = attr->cat_ctime;
187 if (valid & CAT_BLOCKS)
188 lvb->lvb_blocks = attr->cat_blocks;
189 if (valid & CAT_KMS) {
190 CDEBUG(D_CACHE, "set kms from "LPU64"to "LPU64"\n",
191 oinfo->loi_kms, (__u64)attr->cat_kms);
192 loi_kms_set(oinfo, attr->cat_kms);
197 static int osc_object_glimpse(const struct lu_env *env,
198 const struct cl_object *obj, struct ost_lvb *lvb)
200 struct lov_oinfo *oinfo = cl2osc(obj)->oo_oinfo;
203 lvb->lvb_size = oinfo->loi_kms;
204 lvb->lvb_blocks = oinfo->loi_lvb.lvb_blocks;
208 static int osc_object_ast_clear(struct ldlm_lock *lock, void *data)
212 if (lock->l_ast_data == data)
213 lock->l_ast_data = NULL;
214 RETURN(LDLM_ITER_CONTINUE);
217 static int osc_object_prune(const struct lu_env *env, struct cl_object *obj)
219 struct osc_object *osc = cl2osc(obj);
220 struct ldlm_res_id *resname = &osc_env_info(env)->oti_resname;
222 LASSERTF(osc->oo_npages == 0,
223 DFID "still have %lu pages, obj: %p, osc: %p\n",
224 PFID(lu_object_fid(&obj->co_lu)), osc->oo_npages, obj, osc);
226 /* DLM locks don't hold a reference of osc_object so we have to
227 * clear it before the object is being destroyed. */
228 ostid_build_res_name(&osc->oo_oinfo->loi_oi, resname);
229 ldlm_resource_iterate(osc_export(osc)->exp_obd->obd_namespace, resname,
230 osc_object_ast_clear, osc);
234 * Find any ldlm lock covers the osc object.
235 * \retval 0 not found
239 static int osc_object_find_cbdata(const struct lu_env *env,
240 struct cl_object *obj, ldlm_iterator_t iter,
243 struct ldlm_res_id res_id;
244 struct obd_device *obd;
247 ostid_build_res_name(&cl2osc(obj)->oo_oinfo->loi_oi, &res_id);
248 obd = obj->co_lu.lo_dev->ld_obd;
249 rc = ldlm_resource_iterate(obd->obd_namespace, &res_id, iter, data);
250 if (rc == LDLM_ITER_STOP)
253 if (rc == LDLM_ITER_CONTINUE)
259 static int osc_object_fiemap(const struct lu_env *env, struct cl_object *obj,
260 struct ll_fiemap_info_key *fmkey,
261 struct fiemap *fiemap, size_t *buflen)
263 struct obd_export *exp = osc_export(cl2osc(obj));
264 struct ldlm_res_id resid;
265 ldlm_policy_data_t policy;
266 struct lustre_handle lockh;
267 ldlm_mode_t mode = 0;
268 struct ptlrpc_request *req;
269 struct fiemap *reply;
274 fmkey->oa.o_oi = cl2osc(obj)->oo_oinfo->loi_oi;
275 if (!(fmkey->fiemap.fm_flags & FIEMAP_FLAG_SYNC))
278 policy.l_extent.start = fmkey->fiemap.fm_start & PAGE_CACHE_MASK;
280 if (OBD_OBJECT_EOF - fmkey->fiemap.fm_length <=
281 fmkey->fiemap.fm_start + PAGE_CACHE_SIZE - 1)
282 policy.l_extent.end = OBD_OBJECT_EOF;
284 policy.l_extent.end = (fmkey->fiemap.fm_start +
285 fmkey->fiemap.fm_length +
286 PAGE_CACHE_SIZE - 1) & PAGE_CACHE_MASK;
288 ostid_build_res_name(&fmkey->oa.o_oi, &resid);
289 mode = ldlm_lock_match(exp->exp_obd->obd_namespace,
290 LDLM_FL_BLOCK_GRANTED | LDLM_FL_LVB_READY,
291 &resid, LDLM_EXTENT, &policy,
292 LCK_PR | LCK_PW, &lockh, 0);
293 if (mode) { /* lock is cached on client */
294 if (mode != LCK_PR) {
295 ldlm_lock_addref(&lockh, LCK_PR);
296 ldlm_lock_decref(&lockh, LCK_PW);
298 } else { /* no cached lock, needs acquire lock on server side */
299 fmkey->oa.o_valid |= OBD_MD_FLFLAGS;
300 fmkey->oa.o_flags |= OBD_FL_SRVLOCK;
304 req = ptlrpc_request_alloc(class_exp2cliimp(exp),
305 &RQF_OST_GET_INFO_FIEMAP);
307 GOTO(drop_lock, rc = -ENOMEM);
309 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_KEY, RCL_CLIENT,
311 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_CLIENT,
313 req_capsule_set_size(&req->rq_pill, &RMF_FIEMAP_VAL, RCL_SERVER,
316 rc = ptlrpc_request_pack(req, LUSTRE_OST_VERSION, OST_GET_INFO);
318 ptlrpc_request_free(req);
321 tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_KEY);
322 memcpy(tmp, fmkey, sizeof(*fmkey));
323 tmp = req_capsule_client_get(&req->rq_pill, &RMF_FIEMAP_VAL);
324 memcpy(tmp, fiemap, *buflen);
325 ptlrpc_request_set_replen(req);
327 rc = ptlrpc_queue_wait(req);
331 reply = req_capsule_server_get(&req->rq_pill, &RMF_FIEMAP_VAL);
333 GOTO(fini_req, rc = -EPROTO);
335 memcpy(fiemap, reply, *buflen);
337 ptlrpc_req_finished(req);
340 ldlm_lock_decref(&lockh, LCK_PR);
344 static int osc_object_obd_info_get(const struct lu_env *env,
345 struct cl_object *obj,
346 struct obd_info *oinfo,
347 struct ptlrpc_request_set *set)
349 struct ptlrpc_request *req;
350 struct osc_async_args *aa;
354 req = ptlrpc_request_alloc(class_exp2cliimp(osc_export(cl2osc(obj))),
359 osc_set_capa_size(req, &RMF_CAPA1, oinfo->oi_capa);
360 rc = ptlrpc_request_pack(req, LUSTRE_OST_VERSION, OST_GETATTR);
362 ptlrpc_request_free(req);
366 osc_pack_req_body(req, oinfo);
368 ptlrpc_request_set_replen(req);
369 req->rq_interpret_reply = (ptlrpc_interpterer_t)osc_getattr_interpret;
371 CLASSERT(sizeof(*aa) <= sizeof(req->rq_async_args));
372 aa = ptlrpc_req_async_args(req);
375 ptlrpc_set_add_req(set, req);
379 void osc_object_set_contended(struct osc_object *obj)
381 obj->oo_contention_time = cfs_time_current();
383 obj->oo_contended = 1;
386 void osc_object_clear_contended(struct osc_object *obj)
388 obj->oo_contended = 0;
391 int osc_object_is_contended(struct osc_object *obj)
393 struct osc_device *dev = lu2osc_dev(obj->oo_cl.co_lu.lo_dev);
394 int osc_contention_time = dev->od_contention_time;
395 cfs_time_t cur_time = cfs_time_current();
396 cfs_time_t retry_time;
398 if (OBD_FAIL_CHECK(OBD_FAIL_OSC_OBJECT_CONTENTION))
401 if (!obj->oo_contended)
405 * I like copy-paste. the code is copied from
406 * ll_file_is_contended.
408 retry_time = cfs_time_add(obj->oo_contention_time,
409 cfs_time_seconds(osc_contention_time));
410 if (cfs_time_after(cur_time, retry_time)) {
411 osc_object_clear_contended(obj);
417 static const struct cl_object_operations osc_ops = {
418 .coo_page_init = osc_page_init,
419 .coo_lock_init = osc_lock_init,
420 .coo_io_init = osc_io_init,
421 .coo_attr_get = osc_attr_get,
422 .coo_attr_update = osc_attr_update,
423 .coo_glimpse = osc_object_glimpse,
424 .coo_prune = osc_object_prune,
425 .coo_find_cbdata = osc_object_find_cbdata,
426 .coo_fiemap = osc_object_fiemap,
427 .coo_obd_info_get = osc_object_obd_info_get,
430 static const struct lu_object_operations osc_lu_obj_ops = {
431 .loo_object_init = osc_object_init,
432 .loo_object_release = NULL,
433 .loo_object_free = osc_object_free,
434 .loo_object_print = osc_object_print,
435 .loo_object_invariant = NULL
438 struct lu_object *osc_object_alloc(const struct lu_env *env,
439 const struct lu_object_header *unused,
440 struct lu_device *dev)
442 struct osc_object *osc;
443 struct lu_object *obj;
445 OBD_SLAB_ALLOC_PTR_GFP(osc, osc_object_kmem, GFP_NOFS);
448 lu_object_init(obj, NULL, dev);
449 osc->oo_cl.co_ops = &osc_ops;
450 obj->lo_ops = &osc_lu_obj_ops;