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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2016, Intel Corporation.
29 * lustre/osp/osp_object.c
31 * Lustre OST Proxy Device (OSP) is the agent on the local MDT for the OST
34 * OSP object attributes cache
35 * ---------------------------
36 * OSP object is the stub of the remote OST-object or MDT-object. Both the
37 * attribute and the extended attributes are stored on the peer side remotely.
38 * It is inefficient to send RPC to peer to fetch those attributes when every
39 * get_attr()/get_xattr() called. For a large system, the LFSCK synchronous
40 * mode scanning is prohibitively inefficient.
42 * So the OSP maintains the OSP object attributes cache to cache some
43 * attributes on the local MDT. The cache is organized against the OSP
46 * struct osp_xattr_entry {
47 * struct list_head oxe_list;
53 * unsigned int oxe_exist:1,
60 * struct lu_attr opo_attr;
61 * struct list_head opo_xattr_list;
62 * spinlock_t opo_lock;
66 * The basic attributes, such as owner/mode/flags, are stored in the
67 * osp_object::opo_attr. The extended attributes will be stored
68 * as osp_xattr_entry. Every extended attribute has an independent
69 * osp_xattr_entry, and all the osp_xattr_entry are linked into the
70 * osp_object::opo_xattr_list. The OSP object attributes cache
71 * is protected by the osp_object::opo_lock.
73 * Not all OSP objects have an attributes cache because maintaining
74 * the cache requires some resources. Currently, the OSP object
75 * attributes cache will be initialized when the attributes or the
76 * extended attributes are pre-fetched via osp_declare_attr_get()
77 * or osp_declare_xattr_get(). That is usually for LFSCK purpose,
78 * but it also can be shared by others.
81 * XXX: NOT prepare out RPC for remote transaction. ((please refer to the
82 * comment of osp_trans_create() for remote transaction)
84 * According to our current transaction/dt_object_lock framework (to make
85 * the cross-MDTs modification for DNE1 to be workable), the transaction
86 * sponsor will start the transaction firstly, then try to acquire related
87 * dt_object_lock if needed. Under such rules, if we want to prepare the
88 * OUT RPC in the transaction declare phase, then related attr/xattr
89 * should be known without dt_object_lock. But such condition maybe not
90 * true for some remote transaction case. For example:
92 * For linkEA repairing (by LFSCK) case, before the LFSCK thread obtained
93 * the dt_object_lock on the target MDT-object, it cannot know whether
94 * the MDT-object has linkEA or not, neither invalid or not.
96 * Since the LFSCK thread cannot hold dt_object_lock before the remote
97 * transaction start (otherwise there will be some potential deadlock),
98 * it cannot prepare related OUT RPC for repairing during the declare
99 * phase as other normal transactions do.
101 * To resolve the trouble, we will make OSP to prepare related OUT RPC
102 * after remote transaction started, and trigger the remote updating
103 * (send RPC) when trans_stop. Then the up layer users, such as LFSCK,
104 * can follow the general rule to handle trans_start/dt_object_lock
105 * for repairing linkEA inconsistency without distinguishing remote
108 * In fact, above solution for remote transaction should be the normal
109 * model without considering DNE1. The trouble brought by DNE1 will be
110 * resolved in DNE2. At that time, this patch can be removed.
113 * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
114 * Author: Mikhail Pershin <mike.tappro@intel.com>
117 #define DEBUG_SUBSYSTEM S_MDS
119 #include <lustre_obdo.h>
120 #include <lustre_swab.h>
122 #include "osp_internal.h"
124 static inline __u32 osp_dev2node(struct osp_device *osp)
126 return osp->opd_storage->dd_lu_dev.ld_site->ld_seq_site->ss_node_id;
129 static inline bool is_ost_obj(struct lu_object *lo)
131 return !lu2osp_dev(lo->lo_dev)->opd_connect_mdt;
135 * Assign FID to the OST object.
137 * This function will assign the FID to the OST object of a striped file.
139 * \param[in] env pointer to the thread context
140 * \param[in] d pointer to the OSP device
141 * \param[in] o pointer to the OSP object that the FID will be
144 static void osp_object_assign_fid(const struct lu_env *env,
145 struct osp_device *d, struct osp_object *o)
147 struct osp_thread_info *osi = osp_env_info(env);
149 LASSERT(fid_is_zero(lu_object_fid(&o->opo_obj.do_lu)));
150 LASSERT(o->opo_reserved);
153 osp_precreate_get_fid(env, d, &osi->osi_fid);
155 lu_object_assign_fid(env, &o->opo_obj.do_lu, &osi->osi_fid);
159 * Find the named extended attribute in the OSP object attributes cache.
161 * The caller should take the osp_object::opo_lock before calling
164 * \param[in] obj pointer to the OSP object
165 * \param[in] name the name of the extended attribute
166 * \param[in] namelen the name length of the extended attribute
168 * \retval pointer to the found extended attribute entry
169 * \retval NULL if the specified extended attribute is not
172 static struct osp_xattr_entry *
173 osp_oac_xattr_find_locked(struct osp_object *obj, const char *name,
176 struct osp_xattr_entry *oxe;
178 list_for_each_entry(oxe, &obj->opo_xattr_list, oxe_list) {
179 if (namelen == oxe->oxe_namelen &&
180 strncmp(name, oxe->oxe_buf, namelen) == 0)
188 * Find the named extended attribute in the OSP object attributes cache.
190 * Call osp_oac_xattr_find_locked() with the osp_object::opo_lock held.
192 * \param[in] obj pointer to the OSP object
193 * \param[in] name the name of the extended attribute
194 * \param[in] unlink true if the extended attribute entry is to be removed
197 * \retval pointer to the found extended attribute entry
198 * \retval NULL if the specified extended attribute is not
201 static struct osp_xattr_entry *osp_oac_xattr_find(struct osp_object *obj,
202 const char *name, bool unlink)
204 struct osp_xattr_entry *oxe = NULL;
206 spin_lock(&obj->opo_lock);
207 oxe = osp_oac_xattr_find_locked(obj, name, strlen(name));
210 list_del_init(&oxe->oxe_list);
212 atomic_inc(&oxe->oxe_ref);
214 spin_unlock(&obj->opo_lock);
220 * Find the named extended attribute in the OSP object attributes cache.
222 * If it is not in the cache, then add an empty entry (that will be
223 * filled later) to cache with the given name.
225 * \param[in] obj pointer to the OSP object
226 * \param[in] name the name of the extended attribute
227 * \param[in] len the length of the extended attribute value
229 * \retval pointer to the found or new-created extended
231 * \retval NULL if the specified extended attribute is not in the
232 * cache or fail to add new empty entry to the cache.
234 static struct osp_xattr_entry *
235 osp_oac_xattr_find_or_add(struct osp_object *obj, const char *name, size_t len)
237 struct osp_xattr_entry *oxe;
238 struct osp_xattr_entry *tmp = NULL;
239 size_t namelen = strlen(name);
240 size_t size = sizeof(*oxe) + namelen + 1 + len;
242 oxe = osp_oac_xattr_find(obj, name, false);
246 OBD_ALLOC(oxe, size);
247 if (unlikely(oxe == NULL))
250 INIT_LIST_HEAD(&oxe->oxe_list);
251 oxe->oxe_buflen = size;
252 oxe->oxe_namelen = namelen;
253 memcpy(oxe->oxe_buf, name, namelen);
254 oxe->oxe_value = oxe->oxe_buf + namelen + 1;
255 /* One ref is for the caller, the other is for the entry on the list. */
256 atomic_set(&oxe->oxe_ref, 2);
258 spin_lock(&obj->opo_lock);
259 tmp = osp_oac_xattr_find_locked(obj, name, namelen);
261 list_add_tail(&oxe->oxe_list, &obj->opo_xattr_list);
263 atomic_inc(&tmp->oxe_ref);
264 spin_unlock(&obj->opo_lock);
275 * Add the given extended attribute to the OSP object attributes cache.
277 * If there is an old extended attributed entry with the same name,
278 * remove it from the cache and return it via the parameter \a poxe.
280 * \param[in] obj pointer to the OSP object
281 * \param[in,out] poxe double pointer to the OSP object extended attribute
282 * entry: the new extended attribute entry is transferred
283 * via such pointer target, and if old the extended
284 * attribute entry exists, then it will be returned back
285 * via such pointer target.
286 * \param[in] len the length of the (new) extended attribute value
288 * \retval pointer to the new extended attribute entry
289 * \retval NULL for failure cases.
291 static struct osp_xattr_entry *
292 osp_oac_xattr_replace(struct osp_object *obj,
293 struct osp_xattr_entry **poxe, size_t len)
295 struct osp_xattr_entry *oxe;
296 size_t namelen = (*poxe)->oxe_namelen;
297 size_t size = sizeof(*oxe) + namelen + 1 + len;
299 OBD_ALLOC(oxe, size);
300 if (unlikely(oxe == NULL))
303 INIT_LIST_HEAD(&oxe->oxe_list);
304 oxe->oxe_buflen = size;
305 oxe->oxe_namelen = namelen;
306 memcpy(oxe->oxe_buf, (*poxe)->oxe_buf, namelen);
307 oxe->oxe_value = oxe->oxe_buf + namelen + 1;
308 /* One ref is for the caller, the other is for the entry on the list. */
309 atomic_set(&oxe->oxe_ref, 2);
311 spin_lock(&obj->opo_lock);
312 *poxe = osp_oac_xattr_find_locked(obj, oxe->oxe_buf, namelen);
313 LASSERT(*poxe != NULL);
315 list_del_init(&(*poxe)->oxe_list);
316 list_add_tail(&oxe->oxe_list, &obj->opo_xattr_list);
317 spin_unlock(&obj->opo_lock);
323 * Release reference from the OSP object extended attribute entry.
325 * If it is the last reference, then free the entry.
327 * \param[in] oxe pointer to the OSP object extended attribute entry.
329 static inline void osp_oac_xattr_put(struct osp_xattr_entry *oxe)
331 if (atomic_dec_and_test(&oxe->oxe_ref)) {
332 LASSERT(list_empty(&oxe->oxe_list));
334 OBD_FREE(oxe, oxe->oxe_buflen);
339 * Parse the OSP object attribute from the RPC reply.
341 * If the attribute is valid, then it will be added to the OSP object
344 * \param[in] env pointer to the thread context
345 * \param[in] reply pointer to the RPC reply
346 * \param[in] req pointer to the RPC request
347 * \param[out] attr pointer to buffer to hold the output attribute
348 * \param[in] obj pointer to the OSP object
349 * \param[in] index the index of the attribute buffer in the reply
351 * \retval 0 for success
352 * \retval negative error number on failure
354 static int osp_get_attr_from_reply(const struct lu_env *env,
355 struct object_update_reply *reply,
356 struct ptlrpc_request *req,
357 struct lu_attr *attr,
358 struct osp_object *obj, int index)
360 struct osp_thread_info *osi = osp_env_info(env);
361 struct lu_buf *rbuf = &osi->osi_lb2;
362 struct obdo *lobdo = &osi->osi_obdo;
366 rc = object_update_result_data_get(reply, rbuf, index);
370 wobdo = rbuf->lb_buf;
371 if (rbuf->lb_len != sizeof(*wobdo))
374 LASSERT(req != NULL);
375 if (ptlrpc_req_need_swab(req))
376 lustre_swab_obdo(wobdo);
378 lustre_get_wire_obdo(NULL, lobdo, wobdo);
379 spin_lock(&obj->opo_lock);
380 la_from_obdo(&obj->opo_attr, lobdo, lobdo->o_valid);
382 *attr = obj->opo_attr;
383 spin_unlock(&obj->opo_lock);
389 * Interpreter function for getting OSP object attribute asynchronously.
391 * Called to interpret the result of an async mode RPC for getting the
392 * OSP object attribute.
394 * \param[in] env pointer to the thread context
395 * \param[in] reply pointer to the RPC reply
396 * \param[in] req pointer to the RPC request
397 * \param[in] obj pointer to the OSP object
398 * \param[out] data pointer to buffer to hold the output attribute
399 * \param[in] index the index of the attribute buffer in the reply
400 * \param[in] rc the result for handling the RPC
402 * \retval 0 for success
403 * \retval negative error number on failure
405 static int osp_attr_get_interpterer(const struct lu_env *env,
406 struct object_update_reply *reply,
407 struct ptlrpc_request *req,
408 struct osp_object *obj,
409 void *data, int index, int rc)
411 struct lu_attr *attr = data;
414 osp2lu_obj(obj)->lo_header->loh_attr |= LOHA_EXISTS;
415 obj->opo_non_exist = 0;
417 return osp_get_attr_from_reply(env, reply, req, NULL, obj,
421 osp2lu_obj(obj)->lo_header->loh_attr &= ~LOHA_EXISTS;
422 obj->opo_non_exist = 1;
425 spin_lock(&obj->opo_lock);
427 spin_unlock(&obj->opo_lock);
434 * Implement OSP layer dt_object_operations::do_declare_attr_get() interface.
436 * Declare that the caller will get attribute from the specified OST object.
438 * This function adds an Object Unified Target (OUT) sub-request to the per-OSP
439 * based shared asynchronous request queue. The osp_attr_get_interpterer()
440 * is registered as the interpreter function to handle the result of this
443 * \param[in] env pointer to the thread context
444 * \param[in] dt pointer to the OSP layer dt_object
446 * \retval 0 for success
447 * \retval negative error number on failure
449 static int osp_declare_attr_get(const struct lu_env *env, struct dt_object *dt)
451 struct osp_object *obj = dt2osp_obj(dt);
452 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
455 mutex_lock(&osp->opd_async_requests_mutex);
456 rc = osp_insert_async_request(env, OUT_ATTR_GET, obj, 0, NULL, NULL,
457 &obj->opo_attr, sizeof(struct obdo),
458 osp_attr_get_interpterer);
459 mutex_unlock(&osp->opd_async_requests_mutex);
465 * Implement OSP layer dt_object_operations::do_attr_get() interface.
467 * Get attribute from the specified MDT/OST object.
469 * If the attribute is in the OSP object attributes cache, then return
470 * the cached attribute directly. Otherwise it will trigger an OUT RPC
471 * to the peer to get the attribute synchronously, if successful, add it
472 * to the OSP attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
474 * \param[in] env pointer to the thread context
475 * \param[in] dt pointer to the OSP layer dt_object
476 * \param[out] attr pointer to the buffer to hold the output attribute
478 * \retval 0 for success
479 * \retval negative error number on failure
481 int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
482 struct lu_attr *attr)
484 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
485 struct osp_object *obj = dt2osp_obj(dt);
486 struct dt_device *dev = &osp->opd_dt_dev;
487 struct osp_update_request *update;
488 struct object_update_reply *reply;
489 struct ptlrpc_request *req = NULL;
493 if (is_ost_obj(&dt->do_lu) && obj->opo_non_exist)
496 spin_lock(&obj->opo_lock);
497 if (obj->opo_attr.la_valid != 0 && !obj->opo_stale) {
498 *attr = obj->opo_attr;
499 spin_unlock(&obj->opo_lock);
503 spin_unlock(&obj->opo_lock);
505 update = osp_update_request_create(dev);
507 RETURN(PTR_ERR(update));
509 rc = osp_update_rpc_pack(env, attr_get, update, OUT_ATTR_GET,
510 lu_object_fid(&dt->do_lu));
512 CERROR("%s: Insert update error "DFID": rc = %d\n",
513 dev->dd_lu_dev.ld_obd->obd_name,
514 PFID(lu_object_fid(&dt->do_lu)), rc);
519 rc = osp_remote_sync(env, osp, update, &req);
522 osp2lu_obj(obj)->lo_header->loh_attr &= ~LOHA_EXISTS;
523 obj->opo_non_exist = 1;
525 CERROR("%s:osp_attr_get update error "DFID": rc = %d\n",
526 dev->dd_lu_dev.ld_obd->obd_name,
527 PFID(lu_object_fid(&dt->do_lu)), rc);
533 osp2lu_obj(obj)->lo_header->loh_attr |= LOHA_EXISTS;
534 obj->opo_non_exist = 0;
535 reply = req_capsule_server_sized_get(&req->rq_pill,
536 &RMF_OUT_UPDATE_REPLY,
537 OUT_UPDATE_REPLY_SIZE);
538 if (reply == NULL || reply->ourp_magic != UPDATE_REPLY_MAGIC)
539 GOTO(out, rc = -EPROTO);
541 rc = osp_get_attr_from_reply(env, reply, req, attr, obj, 0);
545 spin_lock(&obj->opo_lock);
547 spin_unlock(&obj->opo_lock);
553 ptlrpc_req_finished(req);
555 osp_update_request_destroy(env, update);
561 * Implement OSP layer dt_object_operations::do_declare_attr_set() interface.
563 * If the transaction is not remote one, then declare the credits that will
564 * be used for the subsequent llog record for the object's attributes.
566 * \param[in] env pointer to the thread context
567 * \param[in] dt pointer to the OSP layer dt_object
568 * \param[in] attr pointer to the attribute to be set
569 * \param[in] th pointer to the transaction handler
571 * \retval 0 for success
572 * \retval negative error number on failure
574 static int osp_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
575 const struct lu_attr *attr, struct thandle *th)
577 struct osp_device *d = lu2osp_dev(dt->do_lu.lo_dev);
578 struct osp_object *o = dt2osp_obj(dt);
581 if (is_only_remote_trans(th))
582 return osp_md_declare_attr_set(env, dt, attr, th);
584 * Usually we don't allow server stack to manipulate size
585 * but there is a special case when striping is created
586 * late, after stripeless file got truncated to non-zero.
588 * In this case we do the following:
590 * 1) grab id in declare - this can lead to leaked OST objects
591 * but we don't currently have proper mechanism and the only
592 * options we have are to do truncate RPC holding transaction
593 * open (very bad) or to grab id in declare at cost of leaked
594 * OST object in same very rare unfortunate case (just bad)
595 * notice 1.6-2.0 do assignment outside of running transaction
596 * all the time, meaning many more chances for leaked objects.
598 * 2) send synchronous truncate RPC with just assigned id
601 /* there are few places in MDD code still passing NULL
602 * XXX: to be fixed soon */
606 if (attr->la_valid & LA_SIZE && attr->la_size > 0 &&
607 fid_is_zero(lu_object_fid(&o->opo_obj.do_lu))) {
608 LASSERT(!dt_object_exists(dt));
609 osp_object_assign_fid(env, d, o);
610 rc = osp_object_truncate(env, dt, attr->la_size);
615 if (!(attr->la_valid & (LA_UID | LA_GID)))
618 /* track all UID/GID changes via llog */
619 rc = osp_sync_declare_add(env, o, MDS_SETATTR64_REC, th);
625 * Implement OSP layer dt_object_operations::do_attr_set() interface.
627 * Set attribute to the specified OST object.
629 * If the transaction is a remote one, then add OUT_ATTR_SET sub-request
630 * in the OUT RPC that will be flushed when the remote transaction stop.
631 * Otherwise, it will generate a MDS_SETATTR64_REC record in the llog that
632 * will be handled by a dedicated thread asynchronously.
634 * If the attribute entry exists in the OSP object attributes cache,
635 * then update the cached attribute according to given attribute.
637 * \param[in] env pointer to the thread context
638 * \param[in] dt pointer to the OSP layer dt_object
639 * \param[in] attr pointer to the attribute to be set
640 * \param[in] th pointer to the transaction handler
642 * \retval 0 for success
643 * \retval negative error number on failure
645 static int osp_attr_set(const struct lu_env *env, struct dt_object *dt,
646 const struct lu_attr *attr, struct thandle *th)
648 struct osp_object *o = dt2osp_obj(dt);
652 /* we're interested in uid/gid changes only */
653 if (!(attr->la_valid & (LA_UID | LA_GID)))
656 if (!is_only_remote_trans(th)) {
657 rc = osp_sync_add(env, o, MDS_SETATTR64_REC, th, attr);
658 /* XXX: send new uid/gid to OST ASAP? */
662 /* It is for OST-object attr_set directly without updating
663 * local MDT-object attribute. It is usually used by LFSCK. */
664 rc = osp_md_attr_set(env, dt, attr, th);
665 CDEBUG(D_INFO, "(1) set attr "DFID": rc = %d\n",
666 PFID(&dt->do_lu.lo_header->loh_fid), rc);
671 /* Update the OSP object attributes cache. */
673 spin_lock(&o->opo_lock);
674 if (attr->la_valid & LA_UID) {
675 la->la_uid = attr->la_uid;
676 la->la_valid |= LA_UID;
679 if (attr->la_valid & LA_GID) {
680 la->la_gid = attr->la_gid;
681 la->la_valid |= LA_GID;
683 spin_unlock(&o->opo_lock);
690 * Interpreter function for getting OSP object extended attribute asynchronously
692 * Called to interpret the result of an async mode RPC for getting the
693 * OSP object extended attribute.
695 * \param[in] env pointer to the thread context
696 * \param[in] reply pointer to the RPC reply
697 * \param[in] req pointer to the RPC request
698 * \param[in] obj pointer to the OSP object
699 * \param[out] data pointer to OSP object attributes cache
700 * \param[in] index the index of the attribute buffer in the reply
701 * \param[in] rc the result for handling the RPC
703 * \retval 0 for success
704 * \retval negative error number on failure
706 static int osp_xattr_get_interpterer(const struct lu_env *env,
707 struct object_update_reply *reply,
708 struct ptlrpc_request *req,
709 struct osp_object *obj,
710 void *data, int index, int rc)
712 struct osp_xattr_entry *oxe = data;
713 struct lu_buf *rbuf = &osp_env_info(env)->osi_lb2;
716 size_t len = sizeof(*oxe) + oxe->oxe_namelen + 1;
718 rc = object_update_result_data_get(reply, rbuf, index);
719 if (rc < 0 || rbuf->lb_len > (oxe->oxe_buflen - len)) {
720 spin_lock(&obj->opo_lock);
722 spin_unlock(&obj->opo_lock);
723 osp_oac_xattr_put(oxe);
725 return rc < 0 ? rc : -ERANGE;
728 spin_lock(&obj->opo_lock);
729 oxe->oxe_vallen = rbuf->lb_len;
730 memcpy(oxe->oxe_value, rbuf->lb_buf, rbuf->lb_len);
733 spin_unlock(&obj->opo_lock);
734 } else if (rc == -ENOENT || rc == -ENODATA) {
735 spin_lock(&obj->opo_lock);
738 spin_unlock(&obj->opo_lock);
740 spin_lock(&obj->opo_lock);
742 spin_unlock(&obj->opo_lock);
745 osp_oac_xattr_put(oxe);
751 * Implement OSP dt_object_operations::do_declare_xattr_get() interface.
753 * Declare that the caller will get extended attribute from the specified
756 * This function will add an OUT_XATTR_GET sub-request to the per OSP
757 * based shared asynchronous request queue with the interpreter function:
758 * osp_xattr_get_interpterer().
760 * \param[in] env pointer to the thread context
761 * \param[in] dt pointer to the OSP layer dt_object
762 * \param[out] buf pointer to the lu_buf to hold the extended attribute
763 * \param[in] name the name for the expected extended attribute
765 * \retval 0 for success
766 * \retval negative error number on failure
768 static int osp_declare_xattr_get(const struct lu_env *env, struct dt_object *dt,
769 struct lu_buf *buf, const char *name)
771 struct osp_object *obj = dt2osp_obj(dt);
772 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
773 struct osp_xattr_entry *oxe;
777 LASSERT(buf != NULL);
778 LASSERT(name != NULL);
780 namelen = strlen(name);
782 /* If only for xattr size, return directly. */
783 if (unlikely(buf->lb_len == 0))
786 oxe = osp_oac_xattr_find_or_add(obj, name, buf->lb_len);
790 mutex_lock(&osp->opd_async_requests_mutex);
791 rc = osp_insert_async_request(env, OUT_XATTR_GET, obj, 1,
792 &namelen, (const void **)&name,
794 osp_xattr_get_interpterer);
796 mutex_unlock(&osp->opd_async_requests_mutex);
797 osp_oac_xattr_put(oxe);
799 struct osp_update_request *our;
800 struct osp_update_request_sub *ours;
802 /* XXX: Currently, we trigger the batched async OUT
803 * RPC via dt_declare_xattr_get(). It is not
804 * perfect solution, but works well now.
806 * We will improve it in the future. */
807 our = osp->opd_async_requests;
808 ours = osp_current_object_update_request(our);
809 if (ours != NULL && ours->ours_req != NULL &&
810 ours->ours_req->ourq_count > 0) {
811 osp->opd_async_requests = NULL;
812 mutex_unlock(&osp->opd_async_requests_mutex);
813 rc = osp_unplug_async_request(env, osp, our);
815 mutex_unlock(&osp->opd_async_requests_mutex);
823 * Implement OSP layer dt_object_operations::do_xattr_get() interface.
825 * Get extended attribute from the specified MDT/OST object.
827 * If the extended attribute is in the OSP object attributes cache, then
828 * return the cached extended attribute directly. Otherwise it will get
829 * the extended attribute synchronously, if successful, add it to the OSP
830 * attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
832 * There is a race condition: some other thread has added the named extended
833 * attributed entry to the OSP object attributes cache during the current
834 * OUT_XATTR_GET handling. If such case happens, the OSP will replace the
835 * (just) existing extended attribute entry with the new replied one.
837 * \param[in] env pointer to the thread context
838 * \param[in] dt pointer to the OSP layer dt_object
839 * \param[out] buf pointer to the lu_buf to hold the extended attribute
840 * \param[in] name the name for the expected extended attribute
842 * \retval 0 for success
843 * \retval negative error number on failure
845 int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
846 struct lu_buf *buf, const char *name)
848 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
849 struct osp_object *obj = dt2osp_obj(dt);
850 struct dt_device *dev = &osp->opd_dt_dev;
851 struct lu_buf *rbuf = &osp_env_info(env)->osi_lb2;
852 struct osp_update_request *update = NULL;
853 struct ptlrpc_request *req = NULL;
854 struct object_update_reply *reply;
855 struct osp_xattr_entry *oxe = NULL;
856 const char *dname = dt->do_lu.lo_dev->ld_obd->obd_name;
860 LASSERT(buf != NULL);
861 LASSERT(name != NULL);
863 if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_BAD_NETWORK) &&
864 osp->opd_index == cfs_fail_val) {
865 if (is_ost_obj(&dt->do_lu)) {
866 if (osp_dev2node(osp) == cfs_fail_val)
869 if (strcmp(name, XATTR_NAME_LINK) == 0)
874 if (unlikely(obj->opo_non_exist))
877 oxe = osp_oac_xattr_find(obj, name, false);
879 spin_lock(&obj->opo_lock);
880 if (oxe->oxe_ready) {
882 GOTO(unlock, rc = -ENODATA);
884 if (buf->lb_buf == NULL)
885 GOTO(unlock, rc = oxe->oxe_vallen);
887 if (buf->lb_len < oxe->oxe_vallen)
888 GOTO(unlock, rc = -ERANGE);
890 memcpy(buf->lb_buf, oxe->oxe_value,
893 GOTO(unlock, rc = oxe->oxe_vallen);
896 spin_unlock(&obj->opo_lock);
897 osp_oac_xattr_put(oxe);
901 spin_unlock(&obj->opo_lock);
903 update = osp_update_request_create(dev);
905 GOTO(out, rc = PTR_ERR(update));
907 rc = osp_update_rpc_pack(env, xattr_get, update, OUT_XATTR_GET,
908 lu_object_fid(&dt->do_lu), name, buf->lb_len);
910 CERROR("%s: Insert update error "DFID": rc = %d\n",
911 dname, PFID(lu_object_fid(&dt->do_lu)), rc);
915 rc = osp_remote_sync(env, osp, update, &req);
918 dt->do_lu.lo_header->loh_attr &= ~LOHA_EXISTS;
919 obj->opo_non_exist = 1;
923 oxe = osp_oac_xattr_find_or_add(obj, name, buf->lb_len);
926 CWARN("%s: Fail to add xattr (%s) to cache for "
927 DFID" (1): rc = %d\n", dname, name,
928 PFID(lu_object_fid(&dt->do_lu)), rc);
933 spin_lock(&obj->opo_lock);
934 if (rc == -ENOENT || rc == -ENODATA) {
940 spin_unlock(&obj->opo_lock);
945 reply = req_capsule_server_sized_get(&req->rq_pill,
946 &RMF_OUT_UPDATE_REPLY,
947 OUT_UPDATE_REPLY_SIZE);
948 if (reply->ourp_magic != UPDATE_REPLY_MAGIC) {
949 CERROR("%s: Wrong version %x expected %x "DFID": rc = %d\n",
950 dname, reply->ourp_magic, UPDATE_REPLY_MAGIC,
951 PFID(lu_object_fid(&dt->do_lu)), -EPROTO);
953 GOTO(out, rc = -EPROTO);
956 rc = object_update_result_data_get(reply, rbuf, 0);
960 if (buf->lb_buf == NULL)
963 if (unlikely(buf->lb_len < rbuf->lb_len))
964 GOTO(out, rc = -ERANGE);
966 memcpy(buf->lb_buf, rbuf->lb_buf, rbuf->lb_len);
969 oxe = osp_oac_xattr_find_or_add(obj, name, rbuf->lb_len);
971 CWARN("%s: Fail to add xattr (%s) to "
972 "cache for "DFID" (2): rc = %d\n",
973 dname, name, PFID(lu_object_fid(&dt->do_lu)), rc);
979 if (oxe->oxe_buflen - oxe->oxe_namelen - 1 < rbuf->lb_len) {
980 struct osp_xattr_entry *old = oxe;
981 struct osp_xattr_entry *tmp;
983 tmp = osp_oac_xattr_replace(obj, &old, rbuf->lb_len);
984 osp_oac_xattr_put(oxe);
987 CWARN("%s: Fail to update xattr (%s) to "
988 "cache for "DFID": rc = %d\n",
989 dname, name, PFID(lu_object_fid(&dt->do_lu)), rc);
990 spin_lock(&obj->opo_lock);
992 spin_unlock(&obj->opo_lock);
997 /* Drop the ref for entry on list. */
998 osp_oac_xattr_put(old);
1001 spin_lock(&obj->opo_lock);
1002 oxe->oxe_vallen = rbuf->lb_len;
1003 memcpy(oxe->oxe_value, rbuf->lb_buf, rbuf->lb_len);
1006 spin_unlock(&obj->opo_lock);
1012 ptlrpc_req_finished(req);
1014 if (update != NULL && !IS_ERR(update))
1015 osp_update_request_destroy(env, update);
1018 osp_oac_xattr_put(oxe);
1024 * Implement OSP layer dt_object_operations::do_declare_xattr_set() interface.
1026 * Declare that the caller will set extended attribute to the specified
1029 * If it is non-remote transaction, it will add an OUT_XATTR_SET sub-request
1030 * to the OUT RPC that will be flushed when the transaction start. And if the
1031 * OSP attributes cache is initialized, then check whether the name extended
1032 * attribute entry exists in the cache or not. If yes, replace it; otherwise,
1033 * add the extended attribute to the cache.
1035 * \param[in] env pointer to the thread context
1036 * \param[in] dt pointer to the OSP layer dt_object
1037 * \param[in] buf pointer to the lu_buf to hold the extended attribute
1038 * \param[in] name the name of the extended attribute to be set
1039 * \param[in] flag to indicate the detailed set operation: LU_XATTR_CREATE
1040 * or LU_XATTR_REPLACE or others
1041 * \param[in] th pointer to the transaction handler
1043 * \retval 0 for success
1044 * \retval negative error number on failure
1046 int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
1047 const struct lu_buf *buf, const char *name,
1048 int flag, struct thandle *th)
1050 return osp_trans_update_request_create(th);
1054 * Implement OSP layer dt_object_operations::do_xattr_set() interface.
1056 * Set extended attribute to the specified MDT/OST object.
1058 * Add an OUT_XATTR_SET sub-request into the OUT RPC that will be flushed in
1059 * the transaction stop. And if the OSP attributes cache is initialized, then
1060 * check whether the name extended attribute entry exists in the cache or not.
1061 * If yes, replace it; otherwise, add the extended attribute to the cache.
1063 * \param[in] env pointer to the thread context
1064 * \param[in] dt pointer to the OSP layer dt_object
1065 * \param[in] buf pointer to the lu_buf to hold the extended attribute
1066 * \param[in] name the name of the extended attribute to be set
1067 * \param[in] fl to indicate the detailed set operation: LU_XATTR_CREATE
1068 * or LU_XATTR_REPLACE or others
1069 * \param[in] th pointer to the transaction handler
1071 * \retval 0 for success
1072 * \retval negative error number on failure
1074 int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
1075 const struct lu_buf *buf, const char *name, int fl,
1078 struct osp_object *o = dt2osp_obj(dt);
1079 struct osp_update_request *update;
1080 struct osp_xattr_entry *oxe;
1084 update = thandle_to_osp_update_request(th);
1085 LASSERT(update != NULL);
1087 CDEBUG(D_INODE, DFID" set xattr '%s' with size %zd\n",
1088 PFID(lu_object_fid(&dt->do_lu)), name, buf->lb_len);
1090 rc = osp_update_rpc_pack(env, xattr_set, update, OUT_XATTR_SET,
1091 lu_object_fid(&dt->do_lu), buf, name, fl);
1095 oxe = osp_oac_xattr_find_or_add(o, name, buf->lb_len);
1097 CWARN("%s: cannot cache xattr '%s' of "DFID"\n",
1098 dt->do_lu.lo_dev->ld_obd->obd_name,
1099 name, PFID(lu_object_fid(&dt->do_lu)));
1104 if (oxe->oxe_buflen - oxe->oxe_namelen - 1 < buf->lb_len) {
1105 struct osp_xattr_entry *old = oxe;
1106 struct osp_xattr_entry *tmp;
1108 tmp = osp_oac_xattr_replace(o, &old, buf->lb_len);
1109 osp_oac_xattr_put(oxe);
1112 CWARN("%s: cannot update cached xattr '%s' of "DFID"\n",
1113 dt->do_lu.lo_dev->ld_obd->obd_name,
1114 name, PFID(lu_object_fid(&dt->do_lu)));
1115 spin_lock(&o->opo_lock);
1117 spin_unlock(&o->opo_lock);
1122 /* Drop the ref for entry on list. */
1123 osp_oac_xattr_put(old);
1126 spin_lock(&o->opo_lock);
1127 oxe->oxe_vallen = buf->lb_len;
1128 memcpy(oxe->oxe_value, buf->lb_buf, buf->lb_len);
1131 spin_unlock(&o->opo_lock);
1132 osp_oac_xattr_put(oxe);
1138 * Implement OSP layer dt_object_operations::do_declare_xattr_del() interface.
1140 * Declare that the caller will delete extended attribute on the specified
1143 * If it is non-remote transaction, it will add an OUT_XATTR_DEL sub-request
1144 * to the OUT RPC that will be flushed when the transaction start. And if the
1145 * name extended attribute entry exists in the OSP attributes cache, then remove
1146 * it from the cache.
1148 * \param[in] env pointer to the thread context
1149 * \param[in] dt pointer to the OSP layer dt_object
1150 * \param[in] name the name of the extended attribute to be set
1151 * \param[in] th pointer to the transaction handler
1153 * \retval 0 for success
1154 * \retval negative error number on failure
1156 int osp_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
1157 const char *name, struct thandle *th)
1159 return osp_trans_update_request_create(th);
1163 * Implement OSP layer dt_object_operations::do_xattr_del() interface.
1165 * Delete extended attribute on the specified MDT/OST object.
1167 * If it is remote transaction, it will add an OUT_XATTR_DEL sub-request into
1168 * the OUT RPC that will be flushed when the transaction stop. And if the name
1169 * extended attribute entry exists in the OSP attributes cache, then remove it
1172 * \param[in] env pointer to the thread context
1173 * \param[in] dt pointer to the OSP layer dt_object
1174 * \param[in] name the name of the extended attribute to be set
1175 * \param[in] th pointer to the transaction handler
1177 * \retval 0 for success
1178 * \retval negative error number on failure
1180 int osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
1181 const char *name, struct thandle *th)
1183 struct osp_update_request *update;
1184 const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
1185 struct osp_object *o = dt2osp_obj(dt);
1186 struct osp_xattr_entry *oxe;
1189 update = thandle_to_osp_update_request(th);
1190 LASSERT(update != NULL);
1192 rc = osp_update_rpc_pack(env, xattr_del, update, OUT_XATTR_DEL,
1197 oxe = osp_oac_xattr_find(o, name, true);
1199 /* Drop the ref for entry on list. */
1200 osp_oac_xattr_put(oxe);
1205 void osp_obj_invalidate_cache(struct osp_object *obj)
1207 struct osp_xattr_entry *oxe;
1208 struct osp_xattr_entry *tmp;
1210 spin_lock(&obj->opo_lock);
1211 list_for_each_entry_safe(oxe, tmp, &obj->opo_xattr_list, oxe_list) {
1213 list_del_init(&oxe->oxe_list);
1214 osp_oac_xattr_put(oxe);
1216 obj->opo_attr.la_valid = 0;
1217 spin_unlock(&obj->opo_lock);
1221 * Implement OSP layer dt_object_operations::do_invalidate() interface.
1223 * Invalidate attributes cached on the specified MDT/OST object.
1225 * \param[in] env pointer to the thread context
1226 * \param[in] dt pointer to the OSP layer dt_object
1228 * \retval 0 for success
1229 * \retval negative error number on failure
1231 int osp_invalidate(const struct lu_env *env, struct dt_object *dt)
1233 struct osp_object *obj = dt2osp_obj(dt);
1236 osp_obj_invalidate_cache(obj);
1238 spin_lock(&obj->opo_lock);
1240 spin_unlock(&obj->opo_lock);
1246 * Implement OSP layer dt_object_operations::do_declare_create() interface.
1248 * Declare that the caller will create the OST object.
1250 * If the transaction is a remote transaction and the FID for the OST-object
1251 * has been assigned already, then handle it as creating (remote) MDT object
1252 * via osp_md_declare_object_create(). This function is usually used for LFSCK
1253 * to re-create the lost OST object. Otherwise, if it is not replay case, the
1254 * OSP will reserve pre-created object for the subsequent create operation;
1255 * if the MDT side cached pre-created objects are less than some threshold,
1256 * then it will wakeup the pre-create thread.
1258 * \param[in] env pointer to the thread context
1259 * \param[in] dt pointer to the OSP layer dt_object
1260 * \param[in] attr the attribute for the object to be created
1261 * \param[in] hint pointer to the hint for creating the object, such as
1263 * \param[in] dof pointer to the dt_object_format for help the creation
1264 * \param[in] th pointer to the transaction handler
1266 * \retval 0 for success
1267 * \retval negative error number on failure
1269 static int osp_declare_object_create(const struct lu_env *env,
1270 struct dt_object *dt,
1271 struct lu_attr *attr,
1272 struct dt_allocation_hint *hint,
1273 struct dt_object_format *dof,
1276 struct osp_thread_info *osi = osp_env_info(env);
1277 struct osp_device *d = lu2osp_dev(dt->do_lu.lo_dev);
1278 struct osp_object *o = dt2osp_obj(dt);
1279 const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
1280 struct thandle *local_th;
1285 if (is_only_remote_trans(th) && !fid_is_zero(fid)) {
1286 LASSERT(fid_is_sane(fid));
1288 rc = osp_md_declare_object_create(env, dt, attr, hint, dof, th);
1293 /* should happen to non-0 OSP only so that at least one object
1294 * has been already declared in the scenario and LOD should
1296 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_OSC_CREATE_FAIL) && d->opd_index == 1)
1299 LASSERT(d->opd_last_used_oid_file);
1302 * There can be gaps in precreated ids and record to unlink llog
1303 * XXX: we do not handle gaps yet, implemented before solution
1304 * was found to be racy, so we disabled that. there is no
1305 * point in making useless but expensive llog declaration.
1307 /* rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th); */
1309 local_th = osp_get_storage_thandle(env, th, d);
1310 if (IS_ERR(local_th))
1311 RETURN(PTR_ERR(local_th));
1313 if (unlikely(!fid_is_zero(fid))) {
1314 /* replay case: caller knows fid */
1315 osi->osi_off = sizeof(osi->osi_id) * d->opd_index;
1316 osi->osi_lb.lb_len = sizeof(osi->osi_id);
1317 osi->osi_lb.lb_buf = NULL;
1319 rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
1320 &osi->osi_lb, osi->osi_off,
1326 * in declaration we need to reserve object so that we don't block
1327 * awaiting precreation RPC to complete
1329 rc = osp_precreate_reserve(env, d);
1331 * we also need to declare update to local "last used id" file for
1332 * recovery if object isn't used for a reason, we need to release
1333 * reservation, this can be made in osd_object_release()
1336 /* mark id is reserved: in create we don't want to talk
1338 LASSERT(o->opo_reserved == 0);
1339 o->opo_reserved = 1;
1341 /* common for all OSPs file hystorically */
1342 osi->osi_off = sizeof(osi->osi_id) * d->opd_index;
1343 osi->osi_lb.lb_len = sizeof(osi->osi_id);
1344 osi->osi_lb.lb_buf = NULL;
1345 rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
1346 &osi->osi_lb, osi->osi_off,
1349 /* not needed in the cache anymore */
1350 set_bit(LU_OBJECT_HEARD_BANSHEE,
1351 &dt->do_lu.lo_header->loh_flags);
1357 * Implement OSP layer dt_object_operations::do_create() interface.
1359 * Create the OST object.
1361 * If the transaction is a remote transaction and the FID for the OST-object
1362 * has been assigned already, then handle it as handling MDT object via the
1363 * osp_md_object_create(). For other cases, the OSP will assign FID to the
1364 * object to be created, and update last_used Object ID (OID) file.
1366 * \param[in] env pointer to the thread context
1367 * \param[in] dt pointer to the OSP layer dt_object
1368 * \param[in] attr the attribute for the object to be created
1369 * \param[in] hint pointer to the hint for creating the object, such as
1371 * \param[in] dof pointer to the dt_object_format for help the creation
1372 * \param[in] th pointer to the transaction handler
1374 * \retval 0 for success
1375 * \retval negative error number on failure
1377 static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
1378 struct lu_attr *attr,
1379 struct dt_allocation_hint *hint,
1380 struct dt_object_format *dof, struct thandle *th)
1382 struct osp_thread_info *osi = osp_env_info(env);
1383 struct osp_device *d = lu2osp_dev(dt->do_lu.lo_dev);
1384 struct osp_object *o = dt2osp_obj(dt);
1386 struct lu_fid *fid = &osi->osi_fid;
1387 struct thandle *local_th;
1390 if (is_only_remote_trans(th) &&
1391 !fid_is_zero(lu_object_fid(&dt->do_lu))) {
1392 LASSERT(fid_is_sane(lu_object_fid(&dt->do_lu)));
1394 rc = osp_md_object_create(env, dt, attr, hint, dof, th);
1396 o->opo_non_exist = 0;
1401 o->opo_non_exist = 0;
1402 if (o->opo_reserved) {
1403 /* regular case, fid is assigned holding transaction open */
1404 osp_object_assign_fid(env, d, o);
1407 memcpy(fid, lu_object_fid(&dt->do_lu), sizeof(*fid));
1409 LASSERTF(fid_is_sane(fid), "fid for osp_object %p is insane"DFID"!\n",
1412 if (!o->opo_reserved) {
1413 /* special case, id was assigned outside of transaction
1414 * see comments in osp_declare_attr_set */
1415 LASSERT(d->opd_pre != NULL);
1416 spin_lock(&d->opd_pre_lock);
1417 osp_update_last_fid(d, fid);
1418 spin_unlock(&d->opd_pre_lock);
1421 CDEBUG(D_INODE, "fid for osp_object %p is "DFID"\n", o, PFID(fid));
1423 /* If the precreate ends, it means it will be ready to rollover to
1424 * the new sequence soon, all the creation should be synchronized,
1425 * otherwise during replay, the replay fid will be inconsistent with
1426 * last_used/create fid */
1427 if (osp_precreate_end_seq(env, d) && osp_is_fid_client(d))
1430 local_th = osp_get_storage_thandle(env, th, d);
1431 if (IS_ERR(local_th))
1432 RETURN(PTR_ERR(local_th));
1434 * it's OK if the import is inactive by this moment - id was created
1435 * by OST earlier, we just need to maintain it consistently on the disk
1436 * once import is reconnected, OSP will claim this and other objects
1437 * used and OST either keep them, if they exist or recreate
1440 /* we might have lost precreated objects */
1441 if (unlikely(d->opd_gap_count) > 0) {
1442 LASSERT(d->opd_pre != NULL);
1443 spin_lock(&d->opd_pre_lock);
1444 if (d->opd_gap_count > 0) {
1445 int count = d->opd_gap_count;
1447 ostid_set_id(&osi->osi_oi,
1448 fid_oid(&d->opd_gap_start_fid));
1449 d->opd_gap_count = 0;
1450 spin_unlock(&d->opd_pre_lock);
1452 CDEBUG(D_HA, "Writing gap "DFID"+%d in llog\n",
1453 PFID(&d->opd_gap_start_fid), count);
1454 /* real gap handling is disabled intil ORI-692 will be
1455 * fixed, now we only report gaps */
1457 spin_unlock(&d->opd_pre_lock);
1461 /* Only need update last_used oid file, seq file will only be update
1462 * during seq rollover */
1463 osp_objid_buf_prep(&osi->osi_lb, &osi->osi_off,
1464 &d->opd_last_used_fid.f_oid, d->opd_index);
1466 rc = dt_record_write(env, d->opd_last_used_oid_file, &osi->osi_lb,
1467 &osi->osi_off, local_th);
1469 CDEBUG(D_HA, "%s: Wrote last used FID: "DFID", index %d: %d\n",
1470 d->opd_obd->obd_name, PFID(fid), d->opd_index, rc);
1476 * Implement OSP layer dt_object_operations::do_declare_destroy() interface.
1478 * Declare that the caller will destroy the specified OST object.
1480 * The OST object destroy will be handled via llog asynchronously. This
1481 * function will declare the credits for generating MDS_UNLINK64_REC llog.
1483 * \param[in] env pointer to the thread context
1484 * \param[in] dt pointer to the OSP layer dt_object to be destroyed
1485 * \param[in] th pointer to the transaction handler
1487 * \retval 0 for success
1488 * \retval negative error number on failure
1490 int osp_declare_object_destroy(const struct lu_env *env,
1491 struct dt_object *dt, struct thandle *th)
1493 struct osp_object *o = dt2osp_obj(dt);
1494 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
1499 LASSERT(!osp->opd_connect_mdt);
1500 rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th);
1506 * Implement OSP layer dt_object_operations::do_destroy() interface.
1508 * Destroy the specified OST object.
1510 * The OSP generates a MDS_UNLINK64_REC record in the llog. There
1511 * will be some dedicated thread to handle the llog asynchronously.
1513 * It also marks the object as non-cached.
1515 * \param[in] env pointer to the thread context
1516 * \param[in] dt pointer to the OSP layer dt_object to be destroyed
1517 * \param[in] th pointer to the transaction handler
1519 * \retval 0 for success
1520 * \retval negative error number on failure
1522 static int osp_object_destroy(const struct lu_env *env, struct dt_object *dt,
1525 struct osp_object *o = dt2osp_obj(dt);
1526 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
1531 o->opo_non_exist = 1;
1533 LASSERT(!osp->opd_connect_mdt);
1534 /* once transaction is committed put proper command on
1535 * the queue going to our OST. */
1536 rc = osp_sync_add(env, o, MDS_UNLINK64_REC, th, NULL);
1540 /* not needed in cache any more */
1541 set_bit(LU_OBJECT_HEARD_BANSHEE, &dt->do_lu.lo_header->loh_flags);
1546 static int osp_orphan_index_lookup(const struct lu_env *env,
1547 struct dt_object *dt,
1549 const struct dt_key *key)
1554 static int osp_orphan_index_declare_insert(const struct lu_env *env,
1555 struct dt_object *dt,
1556 const struct dt_rec *rec,
1557 const struct dt_key *key,
1558 struct thandle *handle)
1563 static int osp_orphan_index_insert(const struct lu_env *env,
1564 struct dt_object *dt,
1565 const struct dt_rec *rec,
1566 const struct dt_key *key,
1567 struct thandle *handle,
1573 static int osp_orphan_index_declare_delete(const struct lu_env *env,
1574 struct dt_object *dt,
1575 const struct dt_key *key,
1576 struct thandle *handle)
1581 static int osp_orphan_index_delete(const struct lu_env *env,
1582 struct dt_object *dt,
1583 const struct dt_key *key,
1584 struct thandle *handle)
1590 * Initialize the OSP layer index iteration.
1592 * \param[in] env pointer to the thread context
1593 * \param[in] dt pointer to the index object to be iterated
1594 * \param[in] attr unused
1596 * \retval pointer to the iteration structure
1597 * \retval negative error number on failure
1599 struct dt_it *osp_it_init(const struct lu_env *env, struct dt_object *dt,
1606 return ERR_PTR(-ENOMEM);
1608 it->ooi_pos_ent = -1;
1610 it->ooi_attr = attr;
1612 return (struct dt_it *)it;
1616 * Finalize the OSP layer index iteration.
1618 * \param[in] env pointer to the thread context
1619 * \param[in] di pointer to the iteration structure
1621 void osp_it_fini(const struct lu_env *env, struct dt_it *di)
1623 struct osp_it *it = (struct osp_it *)di;
1624 struct page **pages = it->ooi_pages;
1625 int npages = it->ooi_total_npages;
1628 if (pages != NULL) {
1629 for (i = 0; i < npages; i++) {
1630 if (pages[i] != NULL) {
1631 if (pages[i] == it->ooi_cur_page) {
1633 it->ooi_cur_page = NULL;
1635 __free_page(pages[i]);
1638 OBD_FREE(pages, npages * sizeof(*pages));
1644 * Get more records for the iteration from peer.
1646 * The new records will be filled in an array of pages. The OSP side
1647 * allows 1MB bulk data to be transferred.
1649 * \param[in] env pointer to the thread context
1650 * \param[in] it pointer to the iteration structure
1652 * \retval 0 for success
1653 * \retval negative error number on failure
1655 static int osp_it_fetch(const struct lu_env *env, struct osp_it *it)
1657 struct lu_device *dev = it->ooi_obj->do_lu.lo_dev;
1658 struct osp_device *osp = lu2osp_dev(dev);
1659 struct page **pages;
1660 struct ptlrpc_request *req = NULL;
1661 struct ptlrpc_bulk_desc *desc;
1662 struct idx_info *ii;
1669 npages = min_t(unsigned int, OFD_MAX_BRW_SIZE, 1 << 20);
1670 npages /= PAGE_SIZE;
1672 OBD_ALLOC(pages, npages * sizeof(*pages));
1676 it->ooi_pages = pages;
1677 it->ooi_total_npages = npages;
1678 for (i = 0; i < npages; i++) {
1679 pages[i] = alloc_page(GFP_NOFS);
1680 if (pages[i] == NULL)
1684 req = ptlrpc_request_alloc(osp->opd_obd->u.cli.cl_import,
1689 rc = ptlrpc_request_pack(req, LUSTRE_OBD_VERSION, OBD_IDX_READ);
1691 ptlrpc_request_free(req);
1695 osp_set_req_replay(osp, req);
1696 req->rq_request_portal = OUT_PORTAL;
1697 ii = req_capsule_client_get(&req->rq_pill, &RMF_IDX_INFO);
1698 memset(ii, 0, sizeof(*ii));
1699 if (fid_is_last_id(lu_object_fid(&it->ooi_obj->do_lu))) {
1700 /* LFSCK will iterate orphan object[FID_SEQ_LAYOUT_BTREE,
1701 * ost_index, 0] with LAST_ID FID, so it needs to replace
1702 * the FID with orphan FID here */
1703 ii->ii_fid.f_seq = FID_SEQ_LAYOUT_RBTREE;
1704 ii->ii_fid.f_oid = osp->opd_index;
1705 ii->ii_fid.f_ver = 0;
1706 ii->ii_flags = II_FL_NOHASH;
1707 ii->ii_attrs = osp_dev2node(osp);
1709 ii->ii_fid = *lu_object_fid(&it->ooi_obj->do_lu);
1710 ii->ii_flags = II_FL_NOHASH | II_FL_NOKEY | II_FL_VARKEY |
1712 ii->ii_attrs = it->ooi_attr;
1714 ii->ii_magic = IDX_INFO_MAGIC;
1715 ii->ii_count = npages * LU_PAGE_COUNT;
1716 ii->ii_hash_start = it->ooi_next;
1718 ptlrpc_at_set_req_timeout(req);
1720 desc = ptlrpc_prep_bulk_imp(req, npages, 1,
1721 PTLRPC_BULK_PUT_SINK | PTLRPC_BULK_BUF_KIOV,
1723 &ptlrpc_bulk_kiov_pin_ops);
1725 ptlrpc_request_free(req);
1729 for (i = 0; i < npages; i++)
1730 desc->bd_frag_ops->add_kiov_frag(desc, pages[i], 0,
1733 ptlrpc_request_set_replen(req);
1734 rc = ptlrpc_queue_wait(req);
1738 rc = sptlrpc_cli_unwrap_bulk_read(req, req->rq_bulk,
1739 req->rq_bulk->bd_nob_transferred);
1744 ii = req_capsule_server_get(&req->rq_pill, &RMF_IDX_INFO);
1745 if (ii->ii_magic != IDX_INFO_MAGIC)
1746 GOTO(out, rc = -EPROTO);
1748 npages = (ii->ii_count + LU_PAGE_COUNT - 1) >>
1749 (PAGE_SHIFT - LU_PAGE_SHIFT);
1750 if (npages > it->ooi_total_npages) {
1751 CERROR("%s: returned more pages than expected, %u > %u\n",
1752 osp->opd_obd->obd_name, npages, it->ooi_total_npages);
1753 GOTO(out, rc = -EINVAL);
1756 it->ooi_valid_npages = npages;
1757 if (ptlrpc_rep_need_swab(req))
1760 it->ooi_next = ii->ii_hash_end;
1763 ptlrpc_req_finished(req);
1769 * Move the iteration cursor to the next lu_page.
1771 * One system page (PAGE_SIZE) may contain multiple lu_page (4KB),
1772 * that depends on the LU_PAGE_COUNT. If it is not the last lu_page
1773 * in current system page, then move the iteration cursor to the next
1774 * lu_page in current system page. Otherwise, if there are more system
1775 * pages in the cache, then move the iteration cursor to the next system
1776 * page. If all the cached records (pages) have been iterated, then fetch
1777 * more records via osp_it_fetch().
1779 * \param[in] env pointer to the thread context
1780 * \param[in] di pointer to the iteration structure
1782 * \retval positive for end of the directory
1783 * \retval 0 for success
1784 * \retval negative error number on failure
1786 int osp_it_next_page(const struct lu_env *env, struct dt_it *di)
1788 struct osp_it *it = (struct osp_it *)di;
1789 struct lu_idxpage *idxpage;
1790 struct page **pages;
1796 idxpage = it->ooi_cur_idxpage;
1797 if (idxpage != NULL) {
1798 if (idxpage->lip_nr == 0)
1801 if (it->ooi_pos_ent < idxpage->lip_nr) {
1802 CDEBUG(D_INFO, "ooi_pos %d nr %d\n",
1803 (int)it->ooi_pos_ent, (int)idxpage->lip_nr);
1806 it->ooi_cur_idxpage = NULL;
1807 it->ooi_pos_lu_page++;
1810 if (it->ooi_pos_lu_page < LU_PAGE_COUNT) {
1811 it->ooi_cur_idxpage = (void *)it->ooi_cur_page +
1812 LU_PAGE_SIZE * it->ooi_pos_lu_page;
1814 lustre_swab_lip_header(it->ooi_cur_idxpage);
1815 if (it->ooi_cur_idxpage->lip_magic != LIP_MAGIC) {
1816 struct osp_device *osp =
1817 lu2osp_dev(it->ooi_obj->do_lu.lo_dev);
1819 CERROR("%s: invalid magic (%x != %x) for page "
1820 "%d/%d while read layout orphan index\n",
1821 osp->opd_obd->obd_name,
1822 it->ooi_cur_idxpage->lip_magic,
1823 LIP_MAGIC, it->ooi_pos_page,
1824 it->ooi_pos_lu_page);
1825 /* Skip this lu_page next time. */
1826 it->ooi_pos_ent = idxpage->lip_nr - 1;
1829 it->ooi_pos_ent = -1;
1833 kunmap(it->ooi_cur_page);
1834 it->ooi_cur_page = NULL;
1838 pages = it->ooi_pages;
1839 if (it->ooi_pos_page < it->ooi_valid_npages) {
1840 it->ooi_cur_page = kmap(pages[it->ooi_pos_page]);
1841 it->ooi_pos_lu_page = 0;
1845 for (i = 0; i < it->ooi_total_npages; i++) {
1846 if (pages[i] != NULL)
1847 __free_page(pages[i]);
1849 OBD_FREE(pages, it->ooi_total_npages * sizeof(*pages));
1851 it->ooi_pos_page = 0;
1852 it->ooi_total_npages = 0;
1853 it->ooi_valid_npages = 0;
1856 it->ooi_cur_page = NULL;
1857 it->ooi_cur_idxpage = NULL;
1858 it->ooi_pages = NULL;
1861 if (it->ooi_next == II_END_OFF)
1864 rc = osp_it_fetch(env, it);
1872 * Move the iteration cursor to the next record.
1874 * If there are more records in the lu_page, then move the iteration
1875 * cursor to the next record directly. Otherwise, move the iteration
1876 * cursor to the record in the next lu_page via osp_it_next_page()
1878 * \param[in] env pointer to the thread context
1879 * \param[in] di pointer to the iteration structure
1881 * \retval positive for end of the directory
1882 * \retval 0 for success
1883 * \retval negative error number on failure
1885 static int osp_orphan_it_next(const struct lu_env *env, struct dt_it *di)
1887 struct osp_it *it = (struct osp_it *)di;
1888 struct lu_idxpage *idxpage;
1893 idxpage = it->ooi_cur_idxpage;
1894 if (idxpage != NULL) {
1895 if (idxpage->lip_nr == 0)
1899 if (it->ooi_pos_ent < idxpage->lip_nr) {
1901 (struct lu_orphan_ent *)idxpage->lip_entries +
1904 lustre_swab_orphan_ent(it->ooi_ent);
1909 rc = osp_it_next_page(env, di);
1916 int osp_it_get(const struct lu_env *env, struct dt_it *di,
1917 const struct dt_key *key)
1922 void osp_it_put(const struct lu_env *env, struct dt_it *di)
1926 static struct dt_key *osp_orphan_it_key(const struct lu_env *env,
1927 const struct dt_it *di)
1929 struct osp_it *it = (struct osp_it *)di;
1930 struct lu_orphan_ent *ent = (struct lu_orphan_ent *)it->ooi_ent;
1932 if (likely(ent != NULL))
1933 return (struct dt_key *)(&ent->loe_key);
1938 static int osp_orphan_it_key_size(const struct lu_env *env,
1939 const struct dt_it *di)
1941 return sizeof(struct lu_fid);
1944 static int osp_orphan_it_rec(const struct lu_env *env, const struct dt_it *di,
1945 struct dt_rec *rec, __u32 attr)
1947 struct osp_it *it = (struct osp_it *)di;
1948 struct lu_orphan_ent *ent = (struct lu_orphan_ent *)it->ooi_ent;
1950 if (likely(ent != NULL)) {
1951 *(struct lu_orphan_rec *)rec = ent->loe_rec;
1958 __u64 osp_it_store(const struct lu_env *env, const struct dt_it *di)
1960 struct osp_it *it = (struct osp_it *)di;
1962 return it->ooi_next;
1966 * Locate the iteration cursor to the specified position (cookie).
1968 * \param[in] env pointer to the thread context
1969 * \param[in] di pointer to the iteration structure
1970 * \param[in] hash the specified position
1972 * \retval positive number for locating to the exactly position
1974 * \retval 0 for arriving at the end of the iteration
1975 * \retval negative error number on failure
1977 int osp_orphan_it_load(const struct lu_env *env, const struct dt_it *di,
1980 struct osp_it *it = (struct osp_it *)di;
1983 it->ooi_next = hash;
1984 rc = osp_orphan_it_next(env, (struct dt_it *)di);
1994 int osp_it_key_rec(const struct lu_env *env, const struct dt_it *di,
2000 static const struct dt_index_operations osp_orphan_index_ops = {
2001 .dio_lookup = osp_orphan_index_lookup,
2002 .dio_declare_insert = osp_orphan_index_declare_insert,
2003 .dio_insert = osp_orphan_index_insert,
2004 .dio_declare_delete = osp_orphan_index_declare_delete,
2005 .dio_delete = osp_orphan_index_delete,
2007 .init = osp_it_init,
2008 .fini = osp_it_fini,
2009 .next = osp_orphan_it_next,
2012 .key = osp_orphan_it_key,
2013 .key_size = osp_orphan_it_key_size,
2014 .rec = osp_orphan_it_rec,
2015 .store = osp_it_store,
2016 .load = osp_orphan_it_load,
2017 .key_rec = osp_it_key_rec,
2022 * Implement OSP layer dt_object_operations::do_index_try() interface.
2024 * Negotiate the index type.
2026 * If the target index is an IDIF object, then use osp_orphan_index_ops.
2027 * Otherwise, assign osp_md_index_ops to the dt_object::do_index_ops.
2028 * (\see lustre/include/lustre_fid.h for IDIF.)
2030 * \param[in] env pointer to the thread context
2031 * \param[in] dt pointer to the OSP layer dt_object
2032 * \param[in] feat unused
2034 * \retval 0 for success
2036 static int osp_index_try(const struct lu_env *env,
2037 struct dt_object *dt,
2038 const struct dt_index_features *feat)
2040 const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
2042 if (fid_is_last_id(fid) && fid_is_idif(fid))
2043 dt->do_index_ops = &osp_orphan_index_ops;
2045 dt->do_index_ops = &osp_md_index_ops;
2049 static struct dt_object_operations osp_obj_ops = {
2050 .do_declare_attr_get = osp_declare_attr_get,
2051 .do_attr_get = osp_attr_get,
2052 .do_declare_attr_set = osp_declare_attr_set,
2053 .do_attr_set = osp_attr_set,
2054 .do_declare_xattr_get = osp_declare_xattr_get,
2055 .do_xattr_get = osp_xattr_get,
2056 .do_declare_xattr_set = osp_declare_xattr_set,
2057 .do_xattr_set = osp_xattr_set,
2058 .do_declare_create = osp_declare_object_create,
2059 .do_create = osp_object_create,
2060 .do_declare_destroy = osp_declare_object_destroy,
2061 .do_destroy = osp_object_destroy,
2062 .do_index_try = osp_index_try,
2066 * Implement OSP layer lu_object_operations::loo_object_init() interface.
2068 * Initialize the object.
2070 * If it is a remote MDT object, then call do_attr_get() to fetch
2071 * the attribute from the peer.
2073 * \param[in] env pointer to the thread context
2074 * \param[in] o pointer to the OSP layer lu_object
2075 * \param[in] conf unused
2077 * \retval 0 for success
2078 * \retval negative error number on failure
2080 static int osp_object_init(const struct lu_env *env, struct lu_object *o,
2081 const struct lu_object_conf *conf)
2083 struct osp_object *po = lu2osp_obj(o);
2087 spin_lock_init(&po->opo_lock);
2088 o->lo_header->loh_attr |= LOHA_REMOTE;
2089 INIT_LIST_HEAD(&po->opo_xattr_list);
2090 INIT_LIST_HEAD(&po->opo_invalidate_cb_list);
2092 if (is_ost_obj(o)) {
2093 po->opo_obj.do_ops = &osp_obj_ops;
2095 struct lu_attr *la = &osp_env_info(env)->osi_attr;
2097 po->opo_obj.do_ops = &osp_md_obj_ops;
2098 po->opo_obj.do_body_ops = &osp_md_body_ops;
2100 if (conf != NULL && conf->loc_flags & LOC_F_NEW) {
2101 po->opo_non_exist = 1;
2103 rc = po->opo_obj.do_ops->do_attr_get(env, lu2dt_obj(o),
2106 o->lo_header->loh_attr |=
2107 LOHA_EXISTS | (la->la_mode & S_IFMT);
2108 if (rc == -ENOENT) {
2109 po->opo_non_exist = 1;
2113 init_rwsem(&po->opo_sem);
2119 * Implement OSP layer lu_object_operations::loo_object_free() interface.
2121 * Finalize the object.
2123 * If the OSP object has attributes cache, then destroy the cache.
2124 * Free the object finally.
2126 * \param[in] env pointer to the thread context
2127 * \param[in] o pointer to the OSP layer lu_object
2129 static void osp_object_free(const struct lu_env *env, struct lu_object *o)
2131 struct osp_object *obj = lu2osp_obj(o);
2132 struct lu_object_header *h = o->lo_header;
2133 struct osp_xattr_entry *oxe;
2134 struct osp_xattr_entry *tmp;
2137 dt_object_fini(&obj->opo_obj);
2138 lu_object_header_fini(h);
2139 list_for_each_entry_safe(oxe, tmp, &obj->opo_xattr_list, oxe_list) {
2140 list_del(&oxe->oxe_list);
2141 count = atomic_read(&oxe->oxe_ref);
2142 LASSERTF(count == 1,
2143 "Still has %d users on the xattr entry %.*s\n",
2144 count-1, (int)oxe->oxe_namelen, oxe->oxe_buf);
2146 OBD_FREE(oxe, oxe->oxe_buflen);
2148 OBD_SLAB_FREE_PTR(obj, osp_object_kmem);
2152 * Implement OSP layer lu_object_operations::loo_object_release() interface.
2154 * Cleanup (not free) the object.
2156 * If it is a reserved object but failed to be created, or it is an OST
2157 * object, then mark the object as non-cached.
2159 * \param[in] env pointer to the thread context
2160 * \param[in] o pointer to the OSP layer lu_object
2162 static void osp_object_release(const struct lu_env *env, struct lu_object *o)
2164 struct osp_object *po = lu2osp_obj(o);
2165 struct osp_device *d = lu2osp_dev(o->lo_dev);
2170 * release reservation if object was declared but not created
2171 * this may require lu_object_put() in LOD
2173 if (unlikely(po->opo_reserved)) {
2174 LASSERT(d->opd_pre != NULL);
2175 LASSERT(d->opd_pre_reserved > 0);
2176 spin_lock(&d->opd_pre_lock);
2177 d->opd_pre_reserved--;
2178 spin_unlock(&d->opd_pre_lock);
2180 /* not needed in cache any more */
2181 set_bit(LU_OBJECT_HEARD_BANSHEE, &o->lo_header->loh_flags);
2185 /* XXX: Currently, NOT cache OST-object on MDT because:
2186 * 1. it is not often accessed on MDT.
2187 * 2. avoid up layer (such as LFSCK) to load too many
2188 * once-used OST-objects. */
2189 set_bit(LU_OBJECT_HEARD_BANSHEE, &o->lo_header->loh_flags);
2194 static int osp_object_print(const struct lu_env *env, void *cookie,
2195 lu_printer_t p, const struct lu_object *l)
2197 const struct osp_object *o = lu2osp_obj((struct lu_object *)l);
2199 return (*p)(env, cookie, LUSTRE_OSP_NAME"-object@%p", o);
2202 static int osp_object_invariant(const struct lu_object *o)
2207 struct lu_object_operations osp_lu_obj_ops = {
2208 .loo_object_init = osp_object_init,
2209 .loo_object_free = osp_object_free,
2210 .loo_object_release = osp_object_release,
2211 .loo_object_print = osp_object_print,
2212 .loo_object_invariant = osp_object_invariant