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 const char *osp_dto2name(struct osp_object *obj)
131 return obj->opo_obj.do_lu.lo_dev->ld_obd->obd_name;
134 static inline bool is_ost_obj(struct lu_object *lo)
136 return !lu2osp_dev(lo->lo_dev)->opd_connect_mdt;
139 static inline void __osp_oac_xattr_assignment(struct osp_object *obj,
140 struct osp_xattr_entry *oxe,
141 const struct lu_buf *buf)
144 memcpy(oxe->oxe_value, buf->lb_buf, buf->lb_len);
146 oxe->oxe_vallen = buf->lb_len;
152 * Assign FID to the OST object.
154 * This function will assign the FID to the OST object of a striped file.
156 * \param[in] env pointer to the thread context
157 * \param[in] d pointer to the OSP device
158 * \param[in] o pointer to the OSP object that the FID will be
161 static void osp_object_assign_fid(const struct lu_env *env,
162 struct osp_device *d, struct osp_object *o)
164 struct osp_thread_info *osi = osp_env_info(env);
166 LASSERT(fid_is_zero(lu_object_fid(&o->opo_obj.do_lu)));
167 LASSERT(o->opo_reserved);
170 osp_precreate_get_fid(env, d, &osi->osi_fid);
172 lu_object_assign_fid(env, &o->opo_obj.do_lu, &osi->osi_fid);
175 #define OXE_DEFAULT_LEN 16
178 * Release reference from the OSP object extended attribute entry.
180 * If it is the last reference, then free the entry.
182 * \param[in] oxe pointer to the OSP object extended attribute entry.
184 static inline void osp_oac_xattr_put(struct osp_xattr_entry *oxe)
186 if (atomic_dec_and_test(&oxe->oxe_ref)) {
187 LASSERT(list_empty(&oxe->oxe_list));
189 OBD_FREE(oxe, oxe->oxe_buflen);
194 * Find the named extended attribute in the OSP object attributes cache.
196 * The caller should take the osp_object::opo_lock before calling
199 * \param[in] obj pointer to the OSP object
200 * \param[in] name the name of the extended attribute
201 * \param[in] namelen the name length of the extended attribute
203 * \retval pointer to the found extended attribute entry
204 * \retval NULL if the specified extended attribute is not
207 static struct osp_xattr_entry *
208 osp_oac_xattr_find_locked(struct osp_object *obj, const char *name,
211 struct osp_xattr_entry *oxe;
213 list_for_each_entry(oxe, &obj->opo_xattr_list, oxe_list) {
214 if (namelen == oxe->oxe_namelen &&
215 strncmp(name, oxe->oxe_buf, namelen) == 0)
223 * Find the named extended attribute in the OSP object attributes cache.
225 * Call osp_oac_xattr_find_locked() with the osp_object::opo_lock held.
227 * \param[in] obj pointer to the OSP object
228 * \param[in] name the name of the extended attribute
229 * \param[in] unlink true if the extended attribute entry is to be removed
232 * \retval pointer to the found extended attribute entry
233 * \retval NULL if the specified extended attribute is not
236 static struct osp_xattr_entry *osp_oac_xattr_find(struct osp_object *obj,
237 const char *name, bool unlink)
239 struct osp_xattr_entry *oxe = NULL;
241 spin_lock(&obj->opo_lock);
242 oxe = osp_oac_xattr_find_locked(obj, name, strlen(name));
245 list_del_init(&oxe->oxe_list);
247 atomic_inc(&oxe->oxe_ref);
249 spin_unlock(&obj->opo_lock);
255 * Find the named extended attribute in the OSP object attributes cache.
257 * If it is not in the cache, then add an empty entry (that will be
258 * filled later) to cache with the given name.
260 * \param[in] obj pointer to the OSP object
261 * \param[in] name the name of the extended attribute
262 * \param[in] len the length of the extended attribute value
264 * \retval pointer to the found or new-created extended
266 * \retval NULL if the specified extended attribute is not in the
267 * cache or fail to add new empty entry to the cache.
269 static struct osp_xattr_entry *
270 osp_oac_xattr_find_or_add(struct osp_object *obj, const char *name, size_t len)
272 struct osp_xattr_entry *oxe;
273 struct osp_xattr_entry *tmp = NULL;
274 size_t namelen = strlen(name);
275 size_t size = sizeof(*oxe) + namelen + 1 +
276 (len ? len : OXE_DEFAULT_LEN);
278 oxe = osp_oac_xattr_find(obj, name, false);
282 OBD_ALLOC(oxe, size);
286 INIT_LIST_HEAD(&oxe->oxe_list);
287 oxe->oxe_buflen = size;
288 oxe->oxe_namelen = namelen;
289 memcpy(oxe->oxe_buf, name, namelen);
290 oxe->oxe_value = oxe->oxe_buf + namelen + 1;
291 /* One ref is for the caller, the other is for the entry on the list. */
292 atomic_set(&oxe->oxe_ref, 2);
294 spin_lock(&obj->opo_lock);
295 tmp = osp_oac_xattr_find_locked(obj, name, namelen);
297 list_add_tail(&oxe->oxe_list, &obj->opo_xattr_list);
299 atomic_inc(&tmp->oxe_ref);
300 spin_unlock(&obj->opo_lock);
311 * Assign the cached OST-object's EA with the given value.
313 * If the current EA entry in cache has not enough space to hold the new
314 * value, remove it, create a new one, then assign with the given value.
316 * \param[in] obj pointer to the OSP object
317 * \param[in] oxe pointer to the cached EA entry to be assigned
318 * \param[in] buf pointer to the buffer with new EA value
320 * \retval pointer to the new created EA entry in cache if
321 * current entry is not big enough; otherwise, the
322 * input 'oxe' will be returned.
324 static struct osp_xattr_entry *
325 osp_oac_xattr_assignment(struct osp_object *obj, struct osp_xattr_entry *oxe,
326 const struct lu_buf *buf)
328 struct osp_xattr_entry *new = NULL;
329 struct osp_xattr_entry *old = NULL;
330 int namelen = oxe->oxe_namelen;
331 size_t size = sizeof(*oxe) + namelen + 1 + buf->lb_len;
332 bool unlink_only = false;
334 if (oxe->oxe_buflen < size) {
335 OBD_ALLOC(new, size);
337 INIT_LIST_HEAD(&new->oxe_list);
338 new->oxe_buflen = size;
339 new->oxe_namelen = namelen;
340 memcpy(new->oxe_buf, oxe->oxe_buf, namelen);
341 new->oxe_value = new->oxe_buf + namelen + 1;
342 /* One ref is for the caller,
343 * the other is for the entry on the list. */
344 atomic_set(&new->oxe_ref, 2);
345 __osp_oac_xattr_assignment(obj, new, buf);
348 CWARN("%s: cannot update cached xattr %.*s of "DFID"\n",
349 osp_dto2name(obj), namelen, oxe->oxe_buf,
350 PFID(lu_object_fid(&obj->opo_obj.do_lu)));
354 spin_lock(&obj->opo_lock);
355 old = osp_oac_xattr_find_locked(obj, oxe->oxe_buf, namelen);
358 /* Unlink the 'old'. */
359 list_del_init(&old->oxe_list);
361 /* Drop the ref for 'old' on list. */
362 osp_oac_xattr_put(old);
364 /* Drop the ref for current using. */
365 osp_oac_xattr_put(oxe);
368 /* Insert 'new' into list. */
369 list_add_tail(&new->oxe_list, &obj->opo_xattr_list);
370 } else if (unlink_only) {
371 /* Unlink the 'old'. */
372 list_del_init(&old->oxe_list);
374 /* Drop the ref for 'old' on list. */
375 osp_oac_xattr_put(old);
377 __osp_oac_xattr_assignment(obj, oxe, buf);
380 /* Drop the ref for current using. */
381 osp_oac_xattr_put(oxe);
384 /* Someone unlinked the 'old' by race,
385 * insert the 'new' one into list. */
386 list_add_tail(&new->oxe_list, &obj->opo_xattr_list);
388 spin_unlock(&obj->opo_lock);
394 * Parse the OSP object attribute from the RPC reply.
396 * If the attribute is valid, then it will be added to the OSP object
399 * \param[in] env pointer to the thread context
400 * \param[in] reply pointer to the RPC reply
401 * \param[in] req pointer to the RPC request
402 * \param[out] attr pointer to buffer to hold the output attribute
403 * \param[in] obj pointer to the OSP object
404 * \param[in] index the index of the attribute buffer in the reply
406 * \retval 0 for success
407 * \retval negative error number on failure
409 static int osp_get_attr_from_reply(const struct lu_env *env,
410 struct object_update_reply *reply,
411 struct ptlrpc_request *req,
412 struct lu_attr *attr,
413 struct osp_object *obj, int index)
415 struct osp_thread_info *osi = osp_env_info(env);
416 struct lu_buf *rbuf = &osi->osi_lb2;
417 struct obdo *lobdo = &osi->osi_obdo;
421 rc = object_update_result_data_get(reply, rbuf, index);
425 wobdo = rbuf->lb_buf;
426 if (rbuf->lb_len != sizeof(*wobdo))
429 LASSERT(req != NULL);
430 if (ptlrpc_req_need_swab(req))
431 lustre_swab_obdo(wobdo);
433 lustre_get_wire_obdo(NULL, lobdo, wobdo);
434 spin_lock(&obj->opo_lock);
435 la_from_obdo(&obj->opo_attr, lobdo, lobdo->o_valid);
437 *attr = obj->opo_attr;
438 spin_unlock(&obj->opo_lock);
444 * Interpreter function for getting OSP object attribute asynchronously.
446 * Called to interpret the result of an async mode RPC for getting the
447 * OSP object attribute.
449 * \param[in] env pointer to the thread context
450 * \param[in] reply pointer to the RPC reply
451 * \param[in] req pointer to the RPC request
452 * \param[in] obj pointer to the OSP object
453 * \param[out] data pointer to buffer to hold the output attribute
454 * \param[in] index the index of the attribute buffer in the reply
455 * \param[in] rc the result for handling the RPC
457 * \retval 0 for success
458 * \retval negative error number on failure
460 static int osp_attr_get_interpterer(const struct lu_env *env,
461 struct object_update_reply *reply,
462 struct ptlrpc_request *req,
463 struct osp_object *obj,
464 void *data, int index, int rc)
466 struct lu_attr *attr = data;
469 osp2lu_obj(obj)->lo_header->loh_attr |= LOHA_EXISTS;
470 obj->opo_non_exist = 0;
472 return osp_get_attr_from_reply(env, reply, req, NULL, obj,
476 osp2lu_obj(obj)->lo_header->loh_attr &= ~LOHA_EXISTS;
477 obj->opo_non_exist = 1;
480 spin_lock(&obj->opo_lock);
482 spin_unlock(&obj->opo_lock);
489 * Implement OSP layer dt_object_operations::do_declare_attr_get() interface.
491 * Declare that the caller will get attribute from the specified OST object.
493 * This function adds an Object Unified Target (OUT) sub-request to the per-OSP
494 * based shared asynchronous request queue. The osp_attr_get_interpterer()
495 * is registered as the interpreter function to handle the result of this
498 * \param[in] env pointer to the thread context
499 * \param[in] dt pointer to the OSP layer dt_object
501 * \retval 0 for success
502 * \retval negative error number on failure
504 static int osp_declare_attr_get(const struct lu_env *env, struct dt_object *dt)
506 struct osp_object *obj = dt2osp_obj(dt);
507 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
510 mutex_lock(&osp->opd_async_requests_mutex);
511 rc = osp_insert_async_request(env, OUT_ATTR_GET, obj, 0, NULL, NULL,
512 &obj->opo_attr, sizeof(struct obdo),
513 osp_attr_get_interpterer);
514 mutex_unlock(&osp->opd_async_requests_mutex);
520 * Implement OSP layer dt_object_operations::do_attr_get() interface.
522 * Get attribute from the specified MDT/OST object.
524 * If the attribute is in the OSP object attributes cache, then return
525 * the cached attribute directly. Otherwise it will trigger an OUT RPC
526 * to the peer to get the attribute synchronously, if successful, add it
527 * to the OSP attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
529 * \param[in] env pointer to the thread context
530 * \param[in] dt pointer to the OSP layer dt_object
531 * \param[out] attr pointer to the buffer to hold the output attribute
533 * \retval 0 for success
534 * \retval negative error number on failure
536 int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
537 struct lu_attr *attr)
539 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
540 struct osp_object *obj = dt2osp_obj(dt);
541 struct dt_device *dev = &osp->opd_dt_dev;
542 struct osp_update_request *update;
543 struct object_update_reply *reply;
544 struct ptlrpc_request *req = NULL;
548 if (is_ost_obj(&dt->do_lu) && obj->opo_non_exist)
551 spin_lock(&obj->opo_lock);
552 if (obj->opo_attr.la_valid != 0 && !obj->opo_stale) {
553 *attr = obj->opo_attr;
554 spin_unlock(&obj->opo_lock);
558 spin_unlock(&obj->opo_lock);
560 update = osp_update_request_create(dev);
562 RETURN(PTR_ERR(update));
564 rc = osp_update_rpc_pack(env, attr_get, update, OUT_ATTR_GET,
565 lu_object_fid(&dt->do_lu));
567 CERROR("%s: Insert update error "DFID": rc = %d\n",
568 dev->dd_lu_dev.ld_obd->obd_name,
569 PFID(lu_object_fid(&dt->do_lu)), rc);
574 rc = osp_remote_sync(env, osp, update, &req);
577 osp2lu_obj(obj)->lo_header->loh_attr &= ~LOHA_EXISTS;
578 obj->opo_non_exist = 1;
580 CERROR("%s:osp_attr_get update error "DFID": rc = %d\n",
581 dev->dd_lu_dev.ld_obd->obd_name,
582 PFID(lu_object_fid(&dt->do_lu)), rc);
588 osp2lu_obj(obj)->lo_header->loh_attr |= LOHA_EXISTS;
589 obj->opo_non_exist = 0;
590 reply = req_capsule_server_sized_get(&req->rq_pill,
591 &RMF_OUT_UPDATE_REPLY,
592 OUT_UPDATE_REPLY_SIZE);
593 if (reply == NULL || reply->ourp_magic != UPDATE_REPLY_MAGIC)
594 GOTO(out, rc = -EPROTO);
596 rc = osp_get_attr_from_reply(env, reply, req, attr, obj, 0);
600 spin_lock(&obj->opo_lock);
602 spin_unlock(&obj->opo_lock);
608 ptlrpc_req_finished(req);
610 osp_update_request_destroy(env, update);
616 * Implement OSP layer dt_object_operations::do_declare_attr_set() interface.
618 * If the transaction is not remote one, then declare the credits that will
619 * be used for the subsequent llog record for the object's attributes.
621 * \param[in] env pointer to the thread context
622 * \param[in] dt pointer to the OSP layer dt_object
623 * \param[in] attr pointer to the attribute to be set
624 * \param[in] th pointer to the transaction handler
626 * \retval 0 for success
627 * \retval negative error number on failure
629 static int osp_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
630 const struct lu_attr *attr, struct thandle *th)
632 struct osp_device *d = lu2osp_dev(dt->do_lu.lo_dev);
633 struct osp_object *o = dt2osp_obj(dt);
636 if (is_only_remote_trans(th))
637 return osp_md_declare_attr_set(env, dt, attr, th);
639 * Usually we don't allow server stack to manipulate size
640 * but there is a special case when striping is created
641 * late, after stripeless file got truncated to non-zero.
643 * In this case we do the following:
645 * 1) grab id in declare - this can lead to leaked OST objects
646 * but we don't currently have proper mechanism and the only
647 * options we have are to do truncate RPC holding transaction
648 * open (very bad) or to grab id in declare at cost of leaked
649 * OST object in same very rare unfortunate case (just bad)
650 * notice 1.6-2.0 do assignment outside of running transaction
651 * all the time, meaning many more chances for leaked objects.
653 * 2) send synchronous truncate RPC with just assigned id
656 /* there are few places in MDD code still passing NULL
657 * XXX: to be fixed soon */
661 if (attr->la_valid & LA_SIZE && attr->la_size > 0 &&
662 fid_is_zero(lu_object_fid(&o->opo_obj.do_lu))) {
663 LASSERT(!dt_object_exists(dt));
664 osp_object_assign_fid(env, d, o);
665 rc = osp_object_truncate(env, dt, attr->la_size);
670 if (!(attr->la_valid & (LA_UID | LA_GID | LA_PROJID)))
673 /* track all UID/GID changes via llog */
674 rc = osp_sync_declare_add(env, o, MDS_SETATTR64_REC, th);
680 * Implement OSP layer dt_object_operations::do_attr_set() interface.
682 * Set attribute to the specified OST object.
684 * If the transaction is a remote one, then add OUT_ATTR_SET sub-request
685 * in the OUT RPC that will be flushed when the remote transaction stop.
686 * Otherwise, it will generate a MDS_SETATTR64_REC record in the llog that
687 * will be handled by a dedicated thread asynchronously.
689 * If the attribute entry exists in the OSP object attributes cache,
690 * then update the cached attribute according to given attribute.
692 * \param[in] env pointer to the thread context
693 * \param[in] dt pointer to the OSP layer dt_object
694 * \param[in] attr pointer to the attribute to be set
695 * \param[in] th pointer to the transaction handler
697 * \retval 0 for success
698 * \retval negative error number on failure
700 static int osp_attr_set(const struct lu_env *env, struct dt_object *dt,
701 const struct lu_attr *attr, struct thandle *th)
703 struct osp_object *o = dt2osp_obj(dt);
707 /* we're interested in uid/gid/projid changes only */
708 if (!(attr->la_valid & (LA_UID | LA_GID | LA_PROJID)))
711 if (!is_only_remote_trans(th)) {
712 if (attr->la_flags & LUSTRE_SET_SYNC_FL) {
713 struct ptlrpc_request *req = NULL;
714 struct osp_update_request *update = NULL;
715 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
717 update = osp_update_request_create(&osp->opd_dt_dev);
719 RETURN(PTR_ERR(update));
721 rc = osp_update_rpc_pack(env, attr_set, update,
723 lu_object_fid(&dt->do_lu),
726 CERROR("%s: update error "DFID": rc = %d\n",
727 osp->opd_obd->obd_name,
728 PFID(lu_object_fid(&dt->do_lu)), rc);
730 osp_update_request_destroy(env, update);
734 rc = osp_remote_sync(env, osp, update, &req);
736 ptlrpc_req_finished(req);
738 osp_update_request_destroy(env, update);
740 rc = osp_sync_add(env, o, MDS_SETATTR64_REC, th, attr);
741 /* XXX: send new uid/gid to OST ASAP? */
746 /* It is for OST-object attr_set directly without updating
747 * local MDT-object attribute. It is usually used by LFSCK. */
748 rc = osp_md_attr_set(env, dt, attr, th);
749 CDEBUG(D_INFO, "(1) set attr "DFID": rc = %d\n",
750 PFID(&dt->do_lu.lo_header->loh_fid), rc);
755 /* Update the OSP object attributes cache. */
757 spin_lock(&o->opo_lock);
758 if (attr->la_valid & LA_UID) {
759 la->la_uid = attr->la_uid;
760 la->la_valid |= LA_UID;
763 if (attr->la_valid & LA_GID) {
764 la->la_gid = attr->la_gid;
765 la->la_valid |= LA_GID;
767 if (attr->la_valid & LA_PROJID) {
768 la->la_projid = attr->la_projid;
769 la->la_valid |= LA_PROJID;
771 spin_unlock(&o->opo_lock);
778 * Interpreter function for getting OSP object extended attribute asynchronously
780 * Called to interpret the result of an async mode RPC for getting the
781 * OSP object extended attribute.
783 * \param[in] env pointer to the thread context
784 * \param[in] reply pointer to the RPC reply
785 * \param[in] req pointer to the RPC request
786 * \param[in] obj pointer to the OSP object
787 * \param[out] data pointer to OSP object attributes cache
788 * \param[in] index the index of the attribute buffer in the reply
789 * \param[in] rc the result for handling the RPC
791 * \retval 0 for success
792 * \retval negative error number on failure
794 static int osp_xattr_get_interpterer(const struct lu_env *env,
795 struct object_update_reply *reply,
796 struct ptlrpc_request *req,
797 struct osp_object *obj,
798 void *data, int index, int rc)
800 struct osp_xattr_entry *oxe = data;
802 spin_lock(&obj->opo_lock);
804 struct lu_buf *rbuf = &osp_env_info(env)->osi_lb2;
805 size_t len = sizeof(*oxe) + oxe->oxe_namelen + 1;
807 rc = object_update_result_data_get(reply, rbuf, index);
808 if (rc == -ENOENT || rc == -ENODATA || rc == 0) {
814 if (unlikely(rc < 0) ||
815 rbuf->lb_len > (oxe->oxe_buflen - len)) {
820 __osp_oac_xattr_assignment(obj, oxe, rbuf);
821 } else if (rc == -ENOENT || rc == -ENODATA) {
829 spin_unlock(&obj->opo_lock);
831 /* Put the reference obtained in the osp_declare_xattr_get(). */
832 osp_oac_xattr_put(oxe);
838 * Implement OSP dt_object_operations::do_declare_xattr_get() interface.
840 * Declare that the caller will get extended attribute from the specified
843 * This function will add an OUT_XATTR_GET sub-request to the per OSP
844 * based shared asynchronous request queue with the interpreter function:
845 * osp_xattr_get_interpterer().
847 * \param[in] env pointer to the thread context
848 * \param[in] dt pointer to the OSP layer dt_object
849 * \param[out] buf pointer to the lu_buf to hold the extended attribute
850 * \param[in] name the name for the expected extended attribute
852 * \retval 0 for success
853 * \retval negative error number on failure
855 static int osp_declare_xattr_get(const struct lu_env *env, struct dt_object *dt,
856 struct lu_buf *buf, const char *name)
858 struct osp_object *obj = dt2osp_obj(dt);
859 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
860 struct osp_xattr_entry *oxe;
864 LASSERT(buf != NULL);
865 LASSERT(name != NULL);
867 if (unlikely(buf->lb_len == 0))
870 oxe = osp_oac_xattr_find_or_add(obj, name, buf->lb_len);
874 len = strlen(name) + 1;
875 mutex_lock(&osp->opd_async_requests_mutex);
876 rc = osp_insert_async_request(env, OUT_XATTR_GET, obj, 1,
877 &len, (const void **)&name,
879 osp_xattr_get_interpterer);
881 mutex_unlock(&osp->opd_async_requests_mutex);
882 osp_oac_xattr_put(oxe);
884 struct osp_update_request *our;
885 struct osp_update_request_sub *ours;
887 /* XXX: Currently, we trigger the batched async OUT
888 * RPC via dt_declare_xattr_get(). It is not
889 * perfect solution, but works well now.
891 * We will improve it in the future. */
892 our = osp->opd_async_requests;
893 ours = osp_current_object_update_request(our);
894 if (ours != NULL && ours->ours_req != NULL &&
895 ours->ours_req->ourq_count > 0) {
896 osp->opd_async_requests = NULL;
897 mutex_unlock(&osp->opd_async_requests_mutex);
898 rc = osp_unplug_async_request(env, osp, our);
900 mutex_unlock(&osp->opd_async_requests_mutex);
908 * Implement OSP layer dt_object_operations::do_xattr_get() interface.
910 * Get extended attribute from the specified MDT/OST object.
912 * If the extended attribute is in the OSP object attributes cache, then
913 * return the cached extended attribute directly. Otherwise it will get
914 * the extended attribute synchronously, if successful, add it to the OSP
915 * attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
917 * There is a race condition: some other thread has added the named extended
918 * attributed entry to the OSP object attributes cache during the current
919 * OUT_XATTR_GET handling. If such case happens, the OSP will replace the
920 * (just) existing extended attribute entry with the new replied one.
922 * \param[in] env pointer to the thread context
923 * \param[in] dt pointer to the OSP layer dt_object
924 * \param[out] buf pointer to the lu_buf to hold the extended attribute
925 * \param[in] name the name for the expected extended attribute
927 * \retval 0 for success
928 * \retval negative error number on failure
930 int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
931 struct lu_buf *buf, const char *name)
933 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
934 struct osp_object *obj = dt2osp_obj(dt);
935 struct dt_device *dev = &osp->opd_dt_dev;
936 struct lu_buf *rbuf = &osp_env_info(env)->osi_lb2;
937 struct osp_update_request *update = NULL;
938 struct ptlrpc_request *req = NULL;
939 struct object_update_reply *reply;
940 struct osp_xattr_entry *oxe = NULL;
941 const char *dname = osp_dto2name(obj);
945 LASSERT(buf != NULL);
946 LASSERT(name != NULL);
948 if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_BAD_NETWORK) &&
949 osp->opd_index == cfs_fail_val) {
950 if (is_ost_obj(&dt->do_lu)) {
951 if (osp_dev2node(osp) == cfs_fail_val)
954 if (strcmp(name, XATTR_NAME_LINK) == 0)
959 if (unlikely(obj->opo_non_exist))
962 oxe = osp_oac_xattr_find(obj, name, false);
964 spin_lock(&obj->opo_lock);
965 if (oxe->oxe_ready) {
967 GOTO(unlock, rc = -ENODATA);
969 if (buf->lb_buf == NULL)
970 GOTO(unlock, rc = oxe->oxe_vallen);
972 if (buf->lb_len < oxe->oxe_vallen)
973 GOTO(unlock, rc = -ERANGE);
975 memcpy(buf->lb_buf, oxe->oxe_value,
978 GOTO(unlock, rc = oxe->oxe_vallen);
981 spin_unlock(&obj->opo_lock);
982 osp_oac_xattr_put(oxe);
986 spin_unlock(&obj->opo_lock);
988 update = osp_update_request_create(dev);
990 GOTO(out, rc = PTR_ERR(update));
992 rc = osp_update_rpc_pack(env, xattr_get, update, OUT_XATTR_GET,
993 lu_object_fid(&dt->do_lu), name, buf->lb_len);
995 CERROR("%s: Insert update error "DFID": rc = %d\n",
996 dname, PFID(lu_object_fid(&dt->do_lu)), rc);
1000 rc = osp_remote_sync(env, osp, update, &req);
1002 if (rc == -ENOENT) {
1003 dt->do_lu.lo_header->loh_attr &= ~LOHA_EXISTS;
1004 obj->opo_non_exist = 1;
1008 oxe = osp_oac_xattr_find_or_add(obj, name, buf->lb_len);
1011 CWARN("%s: Fail to add xattr (%s) to cache for "
1012 DFID" (1): rc = %d\n", dname, name,
1013 PFID(lu_object_fid(&dt->do_lu)), rc);
1018 spin_lock(&obj->opo_lock);
1019 if (rc == -ENOENT || rc == -ENODATA) {
1025 spin_unlock(&obj->opo_lock);
1030 reply = req_capsule_server_sized_get(&req->rq_pill,
1031 &RMF_OUT_UPDATE_REPLY,
1032 OUT_UPDATE_REPLY_SIZE);
1033 if (reply->ourp_magic != UPDATE_REPLY_MAGIC) {
1034 CERROR("%s: Wrong version %x expected %x "DFID": rc = %d\n",
1035 dname, reply->ourp_magic, UPDATE_REPLY_MAGIC,
1036 PFID(lu_object_fid(&dt->do_lu)), -EPROTO);
1038 GOTO(out, rc = -EPROTO);
1041 rc = object_update_result_data_get(reply, rbuf, 0);
1042 if (rc < 0 || rbuf->lb_len == 0) {
1044 spin_lock(&obj->opo_lock);
1045 if (unlikely(rc == -ENODATA)) {
1051 spin_unlock(&obj->opo_lock);
1057 /* For detecting EA size. */
1062 oxe = osp_oac_xattr_find_or_add(obj, name, rbuf->lb_len);
1064 CWARN("%s: Fail to add xattr (%s) to "
1065 "cache for "DFID" (2): rc = %d\n",
1066 dname, name, PFID(lu_object_fid(&dt->do_lu)), rc);
1072 oxe = osp_oac_xattr_assignment(obj, oxe, rbuf);
1077 if (rc > 0 && buf->lb_buf) {
1078 if (unlikely(buf->lb_len < rbuf->lb_len))
1081 memcpy(buf->lb_buf, rbuf->lb_buf, rbuf->lb_len);
1085 ptlrpc_req_finished(req);
1087 if (update && !IS_ERR(update))
1088 osp_update_request_destroy(env, update);
1091 osp_oac_xattr_put(oxe);
1097 * Implement OSP layer dt_object_operations::do_declare_xattr_set() interface.
1099 * Declare that the caller will set extended attribute to the specified
1102 * If it is non-remote transaction, it will add an OUT_XATTR_SET sub-request
1103 * to the OUT RPC that will be flushed when the transaction start. And if the
1104 * OSP attributes cache is initialized, then check whether the name extended
1105 * attribute entry exists in the cache or not. If yes, replace it; otherwise,
1106 * add the extended attribute to the cache.
1108 * \param[in] env pointer to the thread context
1109 * \param[in] dt pointer to the OSP layer dt_object
1110 * \param[in] buf pointer to the lu_buf to hold the extended attribute
1111 * \param[in] name the name of the extended attribute to be set
1112 * \param[in] flag to indicate the detailed set operation: LU_XATTR_CREATE
1113 * or LU_XATTR_REPLACE or others
1114 * \param[in] th pointer to the transaction handler
1116 * \retval 0 for success
1117 * \retval negative error number on failure
1119 int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
1120 const struct lu_buf *buf, const char *name,
1121 int flag, struct thandle *th)
1123 return osp_trans_update_request_create(th);
1127 * Implement OSP layer dt_object_operations::do_xattr_set() interface.
1129 * Set extended attribute to the specified MDT/OST object.
1131 * Add an OUT_XATTR_SET sub-request into the OUT RPC that will be flushed in
1132 * the transaction stop. And if the OSP attributes cache is initialized, then
1133 * check whether the name extended attribute entry exists in the cache or not.
1134 * If yes, replace it; otherwise, add the extended attribute to the cache.
1136 * \param[in] env pointer to the thread context
1137 * \param[in] dt pointer to the OSP layer dt_object
1138 * \param[in] buf pointer to the lu_buf to hold the extended attribute
1139 * \param[in] name the name of the extended attribute to be set
1140 * \param[in] fl to indicate the detailed set operation: LU_XATTR_CREATE
1141 * or LU_XATTR_REPLACE or others
1142 * \param[in] th pointer to the transaction handler
1144 * \retval 0 for success
1145 * \retval negative error number on failure
1147 int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
1148 const struct lu_buf *buf, const char *name, int fl,
1151 struct osp_object *o = dt2osp_obj(dt);
1152 struct osp_update_request *update;
1153 struct osp_xattr_entry *oxe;
1157 update = thandle_to_osp_update_request(th);
1158 LASSERT(update != NULL);
1160 CDEBUG(D_INODE, DFID" set xattr '%s' with size %zd\n",
1161 PFID(lu_object_fid(&dt->do_lu)), name, buf->lb_len);
1163 rc = osp_update_rpc_pack(env, xattr_set, update, OUT_XATTR_SET,
1164 lu_object_fid(&dt->do_lu), buf, name, fl);
1168 /* Do not cache linkEA that may be self-adjusted by peers
1169 * under EA overflow case. */
1170 if (strcmp(name, XATTR_NAME_LINK) == 0) {
1171 oxe = osp_oac_xattr_find(o, name, true);
1173 osp_oac_xattr_put(oxe);
1178 oxe = osp_oac_xattr_find_or_add(o, name, buf->lb_len);
1180 CWARN("%s: cannot cache xattr '%s' of "DFID"\n",
1181 osp_dto2name(o), name, PFID(lu_object_fid(&dt->do_lu)));
1186 oxe = osp_oac_xattr_assignment(o, oxe, buf);
1188 osp_oac_xattr_put(oxe);
1194 * Implement OSP layer dt_object_operations::do_declare_xattr_del() interface.
1196 * Declare that the caller will delete extended attribute on the specified
1199 * If it is non-remote transaction, it will add an OUT_XATTR_DEL sub-request
1200 * to the OUT RPC that will be flushed when the transaction start. And if the
1201 * name extended attribute entry exists in the OSP attributes cache, then remove
1202 * it from the cache.
1204 * \param[in] env pointer to the thread context
1205 * \param[in] dt pointer to the OSP layer dt_object
1206 * \param[in] name the name of the extended attribute to be set
1207 * \param[in] th pointer to the transaction handler
1209 * \retval 0 for success
1210 * \retval negative error number on failure
1212 int osp_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
1213 const char *name, struct thandle *th)
1215 return osp_trans_update_request_create(th);
1219 * Implement OSP layer dt_object_operations::do_xattr_del() interface.
1221 * Delete extended attribute on the specified MDT/OST object.
1223 * If it is remote transaction, it will add an OUT_XATTR_DEL sub-request into
1224 * the OUT RPC that will be flushed when the transaction stop. And if the name
1225 * extended attribute entry exists in the OSP attributes cache, then remove it
1228 * \param[in] env pointer to the thread context
1229 * \param[in] dt pointer to the OSP layer dt_object
1230 * \param[in] name the name of the extended attribute to be set
1231 * \param[in] th pointer to the transaction handler
1233 * \retval 0 for success
1234 * \retval negative error number on failure
1236 int osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
1237 const char *name, struct thandle *th)
1239 struct osp_update_request *update;
1240 const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
1241 struct osp_object *o = dt2osp_obj(dt);
1242 struct osp_xattr_entry *oxe;
1245 update = thandle_to_osp_update_request(th);
1246 LASSERT(update != NULL);
1248 rc = osp_update_rpc_pack(env, xattr_del, update, OUT_XATTR_DEL,
1253 oxe = osp_oac_xattr_find(o, name, true);
1255 /* Drop the ref for entry on list. */
1256 osp_oac_xattr_put(oxe);
1261 void osp_obj_invalidate_cache(struct osp_object *obj)
1263 struct osp_xattr_entry *oxe;
1264 struct osp_xattr_entry *tmp;
1266 spin_lock(&obj->opo_lock);
1267 list_for_each_entry_safe(oxe, tmp, &obj->opo_xattr_list, oxe_list) {
1269 list_del_init(&oxe->oxe_list);
1270 osp_oac_xattr_put(oxe);
1272 obj->opo_attr.la_valid = 0;
1273 spin_unlock(&obj->opo_lock);
1277 * Implement OSP layer dt_object_operations::do_invalidate() interface.
1279 * Invalidate attributes cached on the specified MDT/OST object.
1281 * \param[in] env pointer to the thread context
1282 * \param[in] dt pointer to the OSP layer dt_object
1284 * \retval 0 for success
1285 * \retval negative error number on failure
1287 int osp_invalidate(const struct lu_env *env, struct dt_object *dt)
1289 struct osp_object *obj = dt2osp_obj(dt);
1292 CDEBUG(D_HA, "Invalidate osp_object "DFID"\n",
1293 PFID(lu_object_fid(&dt->do_lu)));
1294 osp_obj_invalidate_cache(obj);
1296 spin_lock(&obj->opo_lock);
1298 spin_unlock(&obj->opo_lock);
1304 * Implement OSP layer dt_object_operations::do_declare_create() interface.
1306 * Declare that the caller will create the OST object.
1308 * If the transaction is a remote transaction and the FID for the OST-object
1309 * has been assigned already, then handle it as creating (remote) MDT object
1310 * via osp_md_declare_create(). This function is usually used for LFSCK
1311 * to re-create the lost OST object. Otherwise, if it is not replay case, the
1312 * OSP will reserve pre-created object for the subsequent create operation;
1313 * if the MDT side cached pre-created objects are less than some threshold,
1314 * then it will wakeup the pre-create thread.
1316 * \param[in] env pointer to the thread context
1317 * \param[in] dt pointer to the OSP layer dt_object
1318 * \param[in] attr the attribute for the object to be created
1319 * \param[in] hint pointer to the hint for creating the object, such as
1321 * \param[in] dof pointer to the dt_object_format for help the creation
1322 * \param[in] th pointer to the transaction handler
1324 * \retval 0 for success
1325 * \retval negative error number on failure
1327 static int osp_declare_create(const struct lu_env *env, struct dt_object *dt,
1328 struct lu_attr *attr,
1329 struct dt_allocation_hint *hint,
1330 struct dt_object_format *dof, struct thandle *th)
1332 struct osp_thread_info *osi = osp_env_info(env);
1333 struct osp_device *d = lu2osp_dev(dt->do_lu.lo_dev);
1334 struct osp_object *o = dt2osp_obj(dt);
1335 const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
1336 struct thandle *local_th;
1341 if (is_only_remote_trans(th) && !fid_is_zero(fid)) {
1342 LASSERT(fid_is_sane(fid));
1344 rc = osp_md_declare_create(env, dt, attr, hint, dof, th);
1349 /* should happen to non-0 OSP only so that at least one object
1350 * has been already declared in the scenario and LOD should
1352 if (OBD_FAIL_CHECK(OBD_FAIL_MDS_OSC_CREATE_FAIL) && d->opd_index == 1)
1355 LASSERT(d->opd_last_used_oid_file);
1358 * There can be gaps in precreated ids and record to unlink llog
1359 * XXX: we do not handle gaps yet, implemented before solution
1360 * was found to be racy, so we disabled that. there is no
1361 * point in making useless but expensive llog declaration.
1363 /* rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th); */
1365 local_th = osp_get_storage_thandle(env, th, d);
1366 if (IS_ERR(local_th))
1367 RETURN(PTR_ERR(local_th));
1369 if (unlikely(!fid_is_zero(fid))) {
1370 /* replay case: caller knows fid */
1371 osi->osi_off = sizeof(osi->osi_id) * d->opd_index;
1372 osi->osi_lb.lb_len = sizeof(osi->osi_id);
1373 osi->osi_lb.lb_buf = NULL;
1375 rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
1376 &osi->osi_lb, osi->osi_off,
1382 * in declaration we need to reserve object so that we don't block
1383 * awaiting precreation RPC to complete
1385 rc = osp_precreate_reserve(env, d);
1387 * we also need to declare update to local "last used id" file for
1388 * recovery if object isn't used for a reason, we need to release
1389 * reservation, this can be made in osd_object_release()
1392 /* mark id is reserved: in create we don't want to talk
1394 LASSERT(o->opo_reserved == 0);
1395 o->opo_reserved = 1;
1397 /* common for all OSPs file hystorically */
1398 osi->osi_off = sizeof(osi->osi_id) * d->opd_index;
1399 osi->osi_lb.lb_len = sizeof(osi->osi_id);
1400 osi->osi_lb.lb_buf = NULL;
1401 rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
1402 &osi->osi_lb, osi->osi_off,
1405 /* not needed in the cache anymore */
1406 set_bit(LU_OBJECT_HEARD_BANSHEE,
1407 &dt->do_lu.lo_header->loh_flags);
1413 * Implement OSP layer dt_object_operations::do_create() interface.
1415 * Create the OST object.
1417 * If the transaction is a remote transaction and the FID for the OST-object
1418 * has been assigned already, then handle it as handling MDT object via the
1419 * osp_md_create(). For other cases, the OSP will assign FID to the
1420 * object to be created, and update last_used Object ID (OID) file.
1422 * \param[in] env pointer to the thread context
1423 * \param[in] dt pointer to the OSP layer dt_object
1424 * \param[in] attr the attribute for the object to be created
1425 * \param[in] hint pointer to the hint for creating the object, such as
1427 * \param[in] dof pointer to the dt_object_format for help the creation
1428 * \param[in] th pointer to the transaction handler
1430 * \retval 0 for success
1431 * \retval negative error number on failure
1433 static int osp_create(const struct lu_env *env, struct dt_object *dt,
1434 struct lu_attr *attr, struct dt_allocation_hint *hint,
1435 struct dt_object_format *dof, struct thandle *th)
1437 struct osp_thread_info *osi = osp_env_info(env);
1438 struct osp_device *d = lu2osp_dev(dt->do_lu.lo_dev);
1439 struct osp_object *o = dt2osp_obj(dt);
1441 struct lu_fid *fid = &osi->osi_fid;
1442 struct thandle *local_th;
1443 struct lu_fid *last_fid = &d->opd_last_used_fid;
1446 if (is_only_remote_trans(th) &&
1447 !fid_is_zero(lu_object_fid(&dt->do_lu))) {
1448 LASSERT(fid_is_sane(lu_object_fid(&dt->do_lu)));
1450 rc = osp_md_create(env, dt, attr, hint, dof, th);
1452 o->opo_non_exist = 0;
1457 o->opo_non_exist = 0;
1458 if (o->opo_reserved) {
1459 /* regular case, fid is assigned holding transaction open */
1460 osp_object_assign_fid(env, d, o);
1463 memcpy(fid, lu_object_fid(&dt->do_lu), sizeof(*fid));
1465 LASSERTF(fid_is_sane(fid), "fid for osp_object %p is insane"DFID"!\n",
1468 if (!o->opo_reserved) {
1469 /* special case, id was assigned outside of transaction
1470 * see comments in osp_declare_attr_set */
1471 LASSERT(d->opd_pre != NULL);
1472 spin_lock(&d->opd_pre_lock);
1473 osp_update_last_fid(d, fid);
1474 spin_unlock(&d->opd_pre_lock);
1477 CDEBUG(D_INODE, "fid for osp_object %p is "DFID"\n", o, PFID(fid));
1479 /* If the precreate ends, it means it will be ready to rollover to
1480 * the new sequence soon, all the creation should be synchronized,
1481 * otherwise during replay, the replay fid will be inconsistent with
1482 * last_used/create fid */
1483 if (osp_precreate_end_seq(env, d) && osp_is_fid_client(d))
1486 local_th = osp_get_storage_thandle(env, th, d);
1487 if (IS_ERR(local_th))
1488 RETURN(PTR_ERR(local_th));
1490 * it's OK if the import is inactive by this moment - id was created
1491 * by OST earlier, we just need to maintain it consistently on the disk
1492 * once import is reconnected, OSP will claim this and other objects
1493 * used and OST either keep them, if they exist or recreate
1496 /* we might have lost precreated objects */
1497 if (unlikely(d->opd_gap_count) > 0) {
1498 LASSERT(d->opd_pre != NULL);
1499 spin_lock(&d->opd_pre_lock);
1500 if (d->opd_gap_count > 0) {
1501 int count = d->opd_gap_count;
1503 rc = ostid_set_id(&osi->osi_oi,
1504 fid_oid(&d->opd_gap_start_fid));
1506 spin_unlock(&d->opd_pre_lock);
1509 d->opd_gap_count = 0;
1510 spin_unlock(&d->opd_pre_lock);
1512 CDEBUG(D_HA, "Writing gap "DFID"+%d in llog\n",
1513 PFID(&d->opd_gap_start_fid), count);
1514 /* real gap handling is disabled intil ORI-692 will be
1515 * fixed, now we only report gaps */
1517 spin_unlock(&d->opd_pre_lock);
1521 /* Only need update last_used oid file, seq file will only be update
1522 * during seq rollover */
1523 if (fid_is_idif((last_fid)))
1524 osi->osi_id = fid_idif_id(fid_seq(last_fid),
1525 fid_oid(last_fid), fid_ver(last_fid));
1527 osi->osi_id = fid_oid(last_fid);
1528 osp_objid_buf_prep(&osi->osi_lb, &osi->osi_off,
1529 &osi->osi_id, d->opd_index);
1531 rc = dt_record_write(env, d->opd_last_used_oid_file, &osi->osi_lb,
1532 &osi->osi_off, local_th);
1534 CDEBUG(D_HA, "%s: Wrote last used FID: "DFID", index %d: %d\n",
1535 d->opd_obd->obd_name, PFID(fid), d->opd_index, rc);
1541 * Implement OSP layer dt_object_operations::do_declare_destroy() interface.
1543 * Declare that the caller will destroy the specified OST object.
1545 * The OST object destroy will be handled via llog asynchronously. This
1546 * function will declare the credits for generating MDS_UNLINK64_REC llog.
1548 * \param[in] env pointer to the thread context
1549 * \param[in] dt pointer to the OSP layer dt_object to be destroyed
1550 * \param[in] th pointer to the transaction handler
1552 * \retval 0 for success
1553 * \retval negative error number on failure
1555 int osp_declare_destroy(const struct lu_env *env, struct dt_object *dt,
1558 struct osp_object *o = dt2osp_obj(dt);
1559 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
1564 LASSERT(!osp->opd_connect_mdt);
1565 rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th);
1571 * Implement OSP layer dt_object_operations::do_destroy() interface.
1573 * Destroy the specified OST object.
1575 * The OSP generates a MDS_UNLINK64_REC record in the llog. There
1576 * will be some dedicated thread to handle the llog asynchronously.
1578 * It also marks the object as non-cached.
1580 * \param[in] env pointer to the thread context
1581 * \param[in] dt pointer to the OSP layer dt_object to be destroyed
1582 * \param[in] th pointer to the transaction handler
1584 * \retval 0 for success
1585 * \retval negative error number on failure
1587 static int osp_destroy(const struct lu_env *env, struct dt_object *dt,
1590 struct osp_object *o = dt2osp_obj(dt);
1591 struct osp_device *osp = lu2osp_dev(dt->do_lu.lo_dev);
1596 o->opo_non_exist = 1;
1598 LASSERT(!osp->opd_connect_mdt);
1599 /* once transaction is committed put proper command on
1600 * the queue going to our OST. */
1601 rc = osp_sync_add(env, o, MDS_UNLINK64_REC, th, NULL);
1605 /* not needed in cache any more */
1606 set_bit(LU_OBJECT_HEARD_BANSHEE, &dt->do_lu.lo_header->loh_flags);
1611 static int osp_orphan_index_lookup(const struct lu_env *env,
1612 struct dt_object *dt,
1614 const struct dt_key *key)
1619 static int osp_orphan_index_declare_insert(const struct lu_env *env,
1620 struct dt_object *dt,
1621 const struct dt_rec *rec,
1622 const struct dt_key *key,
1623 struct thandle *handle)
1628 static int osp_orphan_index_insert(const struct lu_env *env,
1629 struct dt_object *dt,
1630 const struct dt_rec *rec,
1631 const struct dt_key *key,
1632 struct thandle *handle,
1638 static int osp_orphan_index_declare_delete(const struct lu_env *env,
1639 struct dt_object *dt,
1640 const struct dt_key *key,
1641 struct thandle *handle)
1646 static int osp_orphan_index_delete(const struct lu_env *env,
1647 struct dt_object *dt,
1648 const struct dt_key *key,
1649 struct thandle *handle)
1655 * Initialize the OSP layer index iteration.
1657 * \param[in] env pointer to the thread context
1658 * \param[in] dt pointer to the index object to be iterated
1659 * \param[in] attr unused
1661 * \retval pointer to the iteration structure
1662 * \retval negative error number on failure
1664 struct dt_it *osp_it_init(const struct lu_env *env, struct dt_object *dt,
1671 return ERR_PTR(-ENOMEM);
1673 it->ooi_pos_ent = -1;
1675 it->ooi_attr = attr;
1677 return (struct dt_it *)it;
1681 * Finalize the OSP layer index iteration.
1683 * \param[in] env pointer to the thread context
1684 * \param[in] di pointer to the iteration structure
1686 void osp_it_fini(const struct lu_env *env, struct dt_it *di)
1688 struct osp_it *it = (struct osp_it *)di;
1689 struct page **pages = it->ooi_pages;
1690 int npages = it->ooi_total_npages;
1693 if (pages != NULL) {
1694 for (i = 0; i < npages; i++) {
1695 if (pages[i] != NULL) {
1696 if (pages[i] == it->ooi_cur_page) {
1698 it->ooi_cur_page = NULL;
1700 __free_page(pages[i]);
1703 OBD_FREE(pages, npages * sizeof(*pages));
1709 * Get more records for the iteration from peer.
1711 * The new records will be filled in an array of pages. The OSP side
1712 * allows 1MB bulk data to be transferred.
1714 * \param[in] env pointer to the thread context
1715 * \param[in] it pointer to the iteration structure
1717 * \retval 0 for success
1718 * \retval negative error number on failure
1720 static int osp_it_fetch(const struct lu_env *env, struct osp_it *it)
1722 struct lu_device *dev = it->ooi_obj->do_lu.lo_dev;
1723 struct osp_device *osp = lu2osp_dev(dev);
1724 struct page **pages;
1725 struct ptlrpc_request *req = NULL;
1726 struct ptlrpc_bulk_desc *desc;
1727 struct idx_info *ii;
1734 npages = min_t(unsigned int, OFD_MAX_BRW_SIZE, 1 << 20);
1735 npages /= PAGE_SIZE;
1737 OBD_ALLOC(pages, npages * sizeof(*pages));
1741 it->ooi_pages = pages;
1742 it->ooi_total_npages = npages;
1743 for (i = 0; i < npages; i++) {
1744 pages[i] = alloc_page(GFP_NOFS);
1745 if (pages[i] == NULL)
1749 req = ptlrpc_request_alloc(osp->opd_obd->u.cli.cl_import,
1754 rc = ptlrpc_request_pack(req, LUSTRE_OBD_VERSION, OBD_IDX_READ);
1756 ptlrpc_request_free(req);
1760 osp_set_req_replay(osp, req);
1761 req->rq_request_portal = OUT_PORTAL;
1762 ii = req_capsule_client_get(&req->rq_pill, &RMF_IDX_INFO);
1763 memset(ii, 0, sizeof(*ii));
1764 if (fid_is_last_id(lu_object_fid(&it->ooi_obj->do_lu))) {
1765 /* LFSCK will iterate orphan object[FID_SEQ_LAYOUT_BTREE,
1766 * ost_index, 0] with LAST_ID FID, so it needs to replace
1767 * the FID with orphan FID here */
1768 ii->ii_fid.f_seq = FID_SEQ_LAYOUT_RBTREE;
1769 ii->ii_fid.f_oid = osp->opd_index;
1770 ii->ii_fid.f_ver = 0;
1771 ii->ii_flags = II_FL_NOHASH;
1772 ii->ii_attrs = osp_dev2node(osp);
1774 ii->ii_fid = *lu_object_fid(&it->ooi_obj->do_lu);
1775 ii->ii_flags = II_FL_NOHASH | II_FL_NOKEY | II_FL_VARKEY |
1777 ii->ii_attrs = it->ooi_attr;
1779 ii->ii_magic = IDX_INFO_MAGIC;
1780 ii->ii_count = npages * LU_PAGE_COUNT;
1781 ii->ii_hash_start = it->ooi_next;
1783 ptlrpc_at_set_req_timeout(req);
1785 desc = ptlrpc_prep_bulk_imp(req, npages, 1,
1786 PTLRPC_BULK_PUT_SINK | PTLRPC_BULK_BUF_KIOV,
1788 &ptlrpc_bulk_kiov_pin_ops);
1790 GOTO(out, rc = -ENOMEM);
1792 for (i = 0; i < npages; i++)
1793 desc->bd_frag_ops->add_kiov_frag(desc, pages[i], 0,
1796 ptlrpc_request_set_replen(req);
1797 rc = ptlrpc_queue_wait(req);
1801 rc = sptlrpc_cli_unwrap_bulk_read(req, req->rq_bulk,
1802 req->rq_bulk->bd_nob_transferred);
1807 ii = req_capsule_server_get(&req->rq_pill, &RMF_IDX_INFO);
1808 if (ii->ii_magic != IDX_INFO_MAGIC)
1809 GOTO(out, rc = -EPROTO);
1811 npages = (ii->ii_count + LU_PAGE_COUNT - 1) >>
1812 (PAGE_SHIFT - LU_PAGE_SHIFT);
1813 if (npages > it->ooi_total_npages) {
1814 CERROR("%s: returned more pages than expected, %u > %u\n",
1815 osp->opd_obd->obd_name, npages, it->ooi_total_npages);
1816 GOTO(out, rc = -EINVAL);
1819 it->ooi_rec_size = ii->ii_recsize;
1820 it->ooi_valid_npages = npages;
1821 if (ptlrpc_rep_need_swab(req))
1824 it->ooi_next = ii->ii_hash_end;
1827 ptlrpc_req_finished(req);
1833 * Move the iteration cursor to the next lu_page.
1835 * One system page (PAGE_SIZE) may contain multiple lu_page (4KB),
1836 * that depends on the LU_PAGE_COUNT. If it is not the last lu_page
1837 * in current system page, then move the iteration cursor to the next
1838 * lu_page in current system page. Otherwise, if there are more system
1839 * pages in the cache, then move the iteration cursor to the next system
1840 * page. If all the cached records (pages) have been iterated, then fetch
1841 * more records via osp_it_fetch().
1843 * \param[in] env pointer to the thread context
1844 * \param[in] di pointer to the iteration structure
1846 * \retval positive for end of the directory
1847 * \retval 0 for success
1848 * \retval negative error number on failure
1850 int osp_it_next_page(const struct lu_env *env, struct dt_it *di)
1852 struct osp_it *it = (struct osp_it *)di;
1853 struct lu_idxpage *idxpage;
1854 struct page **pages;
1860 idxpage = it->ooi_cur_idxpage;
1861 if (idxpage != NULL) {
1862 if (idxpage->lip_nr == 0)
1865 if (it->ooi_pos_ent < idxpage->lip_nr) {
1866 CDEBUG(D_INFO, "ooi_pos %d nr %d\n",
1867 (int)it->ooi_pos_ent, (int)idxpage->lip_nr);
1870 it->ooi_cur_idxpage = NULL;
1871 it->ooi_pos_lu_page++;
1874 if (it->ooi_pos_lu_page < LU_PAGE_COUNT) {
1875 it->ooi_cur_idxpage = (void *)it->ooi_cur_page +
1876 LU_PAGE_SIZE * it->ooi_pos_lu_page;
1878 lustre_swab_lip_header(it->ooi_cur_idxpage);
1879 if (it->ooi_cur_idxpage->lip_magic != LIP_MAGIC) {
1880 struct osp_device *osp =
1881 lu2osp_dev(it->ooi_obj->do_lu.lo_dev);
1883 CERROR("%s: invalid magic (%x != %x) for page "
1884 "%d/%d while read layout orphan index\n",
1885 osp->opd_obd->obd_name,
1886 it->ooi_cur_idxpage->lip_magic,
1887 LIP_MAGIC, it->ooi_pos_page,
1888 it->ooi_pos_lu_page);
1889 /* Skip this lu_page next time. */
1890 it->ooi_pos_ent = idxpage->lip_nr - 1;
1893 it->ooi_pos_ent = -1;
1897 kunmap(it->ooi_cur_page);
1898 it->ooi_cur_page = NULL;
1902 pages = it->ooi_pages;
1903 if (it->ooi_pos_page < it->ooi_valid_npages) {
1904 it->ooi_cur_page = kmap(pages[it->ooi_pos_page]);
1905 it->ooi_pos_lu_page = 0;
1909 for (i = 0; i < it->ooi_total_npages; i++) {
1910 if (pages[i] != NULL)
1911 __free_page(pages[i]);
1913 OBD_FREE(pages, it->ooi_total_npages * sizeof(*pages));
1915 it->ooi_pos_page = 0;
1916 it->ooi_total_npages = 0;
1917 it->ooi_valid_npages = 0;
1920 it->ooi_cur_page = NULL;
1921 it->ooi_cur_idxpage = NULL;
1922 it->ooi_pages = NULL;
1925 if (it->ooi_next == II_END_OFF)
1928 rc = osp_it_fetch(env, it);
1936 * Move the iteration cursor to the next record.
1938 * If there are more records in the lu_page, then move the iteration
1939 * cursor to the next record directly. Otherwise, move the iteration
1940 * cursor to the record in the next lu_page via osp_it_next_page()
1942 * \param[in] env pointer to the thread context
1943 * \param[in] di pointer to the iteration structure
1945 * \retval positive for end of the directory
1946 * \retval 0 for success
1947 * \retval negative error number on failure
1949 static int osp_orphan_it_next(const struct lu_env *env, struct dt_it *di)
1951 struct osp_it *it = (struct osp_it *)di;
1952 struct lu_idxpage *idxpage;
1957 idxpage = it->ooi_cur_idxpage;
1958 if (idxpage != NULL) {
1959 if (idxpage->lip_nr == 0)
1963 if (it->ooi_pos_ent < idxpage->lip_nr) {
1964 if (it->ooi_rec_size ==
1965 sizeof(struct lu_orphan_rec_v2)) {
1967 (struct lu_orphan_ent_v2 *)idxpage->lip_entries+
1970 lustre_swab_orphan_ent_v2(it->ooi_ent);
1973 (struct lu_orphan_ent *)idxpage->lip_entries +
1976 lustre_swab_orphan_ent(it->ooi_ent);
1982 rc = osp_it_next_page(env, di);
1989 int osp_it_get(const struct lu_env *env, struct dt_it *di,
1990 const struct dt_key *key)
1995 void osp_it_put(const struct lu_env *env, struct dt_it *di)
1999 static struct dt_key *osp_orphan_it_key(const struct lu_env *env,
2000 const struct dt_it *di)
2002 struct osp_it *it = (struct osp_it *)di;
2003 struct lu_orphan_ent *ent = (struct lu_orphan_ent *)it->ooi_ent;
2005 if (likely(ent != NULL))
2006 return (struct dt_key *)(&ent->loe_key);
2011 static int osp_orphan_it_key_size(const struct lu_env *env,
2012 const struct dt_it *di)
2014 return sizeof(struct lu_fid);
2017 static int osp_orphan_it_rec(const struct lu_env *env, const struct dt_it *di,
2018 struct dt_rec *rec, __u32 attr)
2020 struct osp_it *it = (struct osp_it *)di;
2022 if (likely(it->ooi_ent)) {
2023 if (it->ooi_rec_size == sizeof(struct lu_orphan_rec_v2)) {
2024 struct lu_orphan_ent_v2 *ent =
2025 (struct lu_orphan_ent_v2 *)it->ooi_ent;
2027 *(struct lu_orphan_rec_v2 *)rec = ent->loe_rec;
2029 struct lu_orphan_ent *ent =
2030 (struct lu_orphan_ent *)it->ooi_ent;
2032 *(struct lu_orphan_rec *)rec = ent->loe_rec;
2040 __u64 osp_it_store(const struct lu_env *env, const struct dt_it *di)
2042 struct osp_it *it = (struct osp_it *)di;
2044 return it->ooi_next;
2048 * Locate the iteration cursor to the specified position (cookie).
2050 * \param[in] env pointer to the thread context
2051 * \param[in] di pointer to the iteration structure
2052 * \param[in] hash the specified position
2054 * \retval positive number for locating to the exactly position
2056 * \retval 0 for arriving at the end of the iteration
2057 * \retval negative error number on failure
2059 int osp_orphan_it_load(const struct lu_env *env, const struct dt_it *di,
2062 struct osp_it *it = (struct osp_it *)di;
2065 it->ooi_next = hash;
2066 rc = osp_orphan_it_next(env, (struct dt_it *)di);
2076 int osp_it_key_rec(const struct lu_env *env, const struct dt_it *di,
2082 static const struct dt_index_operations osp_orphan_index_ops = {
2083 .dio_lookup = osp_orphan_index_lookup,
2084 .dio_declare_insert = osp_orphan_index_declare_insert,
2085 .dio_insert = osp_orphan_index_insert,
2086 .dio_declare_delete = osp_orphan_index_declare_delete,
2087 .dio_delete = osp_orphan_index_delete,
2089 .init = osp_it_init,
2090 .fini = osp_it_fini,
2091 .next = osp_orphan_it_next,
2094 .key = osp_orphan_it_key,
2095 .key_size = osp_orphan_it_key_size,
2096 .rec = osp_orphan_it_rec,
2097 .store = osp_it_store,
2098 .load = osp_orphan_it_load,
2099 .key_rec = osp_it_key_rec,
2104 * Implement OSP layer dt_object_operations::do_index_try() interface.
2106 * Negotiate the index type.
2108 * If the target index is an IDIF object, then use osp_orphan_index_ops.
2109 * Otherwise, assign osp_md_index_ops to the dt_object::do_index_ops.
2110 * (\see lustre/include/lustre_fid.h for IDIF.)
2112 * \param[in] env pointer to the thread context
2113 * \param[in] dt pointer to the OSP layer dt_object
2114 * \param[in] feat unused
2116 * \retval 0 for success
2118 static int osp_index_try(const struct lu_env *env,
2119 struct dt_object *dt,
2120 const struct dt_index_features *feat)
2122 const struct lu_fid *fid = lu_object_fid(&dt->do_lu);
2124 if (fid_is_last_id(fid) && fid_is_idif(fid))
2125 dt->do_index_ops = &osp_orphan_index_ops;
2127 dt->do_index_ops = &osp_md_index_ops;
2131 static struct dt_object_operations osp_obj_ops = {
2132 .do_declare_attr_get = osp_declare_attr_get,
2133 .do_attr_get = osp_attr_get,
2134 .do_declare_attr_set = osp_declare_attr_set,
2135 .do_attr_set = osp_attr_set,
2136 .do_declare_xattr_get = osp_declare_xattr_get,
2137 .do_xattr_get = osp_xattr_get,
2138 .do_declare_xattr_set = osp_declare_xattr_set,
2139 .do_xattr_set = osp_xattr_set,
2140 .do_declare_create = osp_declare_create,
2141 .do_create = osp_create,
2142 .do_declare_destroy = osp_declare_destroy,
2143 .do_destroy = osp_destroy,
2144 .do_index_try = osp_index_try,
2148 * Implement OSP layer lu_object_operations::loo_object_init() interface.
2150 * Initialize the object.
2152 * If it is a remote MDT object, then call do_attr_get() to fetch
2153 * the attribute from the peer.
2155 * \param[in] env pointer to the thread context
2156 * \param[in] o pointer to the OSP layer lu_object
2157 * \param[in] conf unused
2159 * \retval 0 for success
2160 * \retval negative error number on failure
2162 static int osp_object_init(const struct lu_env *env, struct lu_object *o,
2163 const struct lu_object_conf *conf)
2165 struct osp_object *po = lu2osp_obj(o);
2169 spin_lock_init(&po->opo_lock);
2170 o->lo_header->loh_attr |= LOHA_REMOTE;
2171 INIT_LIST_HEAD(&po->opo_xattr_list);
2172 INIT_LIST_HEAD(&po->opo_invalidate_cb_list);
2174 if (is_ost_obj(o)) {
2175 po->opo_obj.do_ops = &osp_obj_ops;
2177 struct lu_attr *la = &osp_env_info(env)->osi_attr;
2179 po->opo_obj.do_ops = &osp_md_obj_ops;
2180 po->opo_obj.do_body_ops = &osp_md_body_ops;
2182 if (conf != NULL && conf->loc_flags & LOC_F_NEW) {
2183 po->opo_non_exist = 1;
2185 rc = po->opo_obj.do_ops->do_attr_get(env, lu2dt_obj(o),
2188 o->lo_header->loh_attr |=
2189 LOHA_EXISTS | (la->la_mode & S_IFMT);
2190 if (rc == -ENOENT) {
2191 po->opo_non_exist = 1;
2195 init_rwsem(&po->opo_sem);
2201 * Implement OSP layer lu_object_operations::loo_object_free() interface.
2203 * Finalize the object.
2205 * If the OSP object has attributes cache, then destroy the cache.
2206 * Free the object finally.
2208 * \param[in] env pointer to the thread context
2209 * \param[in] o pointer to the OSP layer lu_object
2211 static void osp_object_free(const struct lu_env *env, struct lu_object *o)
2213 struct osp_object *obj = lu2osp_obj(o);
2214 struct lu_object_header *h = o->lo_header;
2215 struct osp_xattr_entry *oxe;
2216 struct osp_xattr_entry *tmp;
2219 dt_object_fini(&obj->opo_obj);
2220 lu_object_header_fini(h);
2221 list_for_each_entry_safe(oxe, tmp, &obj->opo_xattr_list, oxe_list) {
2222 list_del(&oxe->oxe_list);
2223 count = atomic_read(&oxe->oxe_ref);
2224 LASSERTF(count == 1,
2225 "Still has %d users on the xattr entry %.*s\n",
2226 count-1, (int)oxe->oxe_namelen, oxe->oxe_buf);
2228 OBD_FREE(oxe, oxe->oxe_buflen);
2230 OBD_SLAB_FREE_PTR(obj, osp_object_kmem);
2234 * Implement OSP layer lu_object_operations::loo_object_release() interface.
2236 * Cleanup (not free) the object.
2238 * If it is a reserved object but failed to be created, or it is an OST
2239 * object, then mark the object as non-cached.
2241 * \param[in] env pointer to the thread context
2242 * \param[in] o pointer to the OSP layer lu_object
2244 static void osp_object_release(const struct lu_env *env, struct lu_object *o)
2246 struct osp_object *po = lu2osp_obj(o);
2247 struct osp_device *d = lu2osp_dev(o->lo_dev);
2252 * release reservation if object was declared but not created
2253 * this may require lu_object_put() in LOD
2255 if (unlikely(po->opo_reserved)) {
2256 LASSERT(d->opd_pre != NULL);
2257 LASSERT(d->opd_pre_reserved > 0);
2258 spin_lock(&d->opd_pre_lock);
2259 d->opd_pre_reserved--;
2260 spin_unlock(&d->opd_pre_lock);
2262 /* not needed in cache any more */
2263 set_bit(LU_OBJECT_HEARD_BANSHEE, &o->lo_header->loh_flags);
2267 /* XXX: Currently, NOT cache OST-object on MDT because:
2268 * 1. it is not often accessed on MDT.
2269 * 2. avoid up layer (such as LFSCK) to load too many
2270 * once-used OST-objects. */
2271 set_bit(LU_OBJECT_HEARD_BANSHEE, &o->lo_header->loh_flags);
2276 static int osp_object_print(const struct lu_env *env, void *cookie,
2277 lu_printer_t p, const struct lu_object *l)
2279 const struct osp_object *o = lu2osp_obj((struct lu_object *)l);
2281 return (*p)(env, cookie, LUSTRE_OSP_NAME"-object@%p", o);
2284 static int osp_object_invariant(const struct lu_object *o)
2289 struct lu_object_operations osp_lu_obj_ops = {
2290 .loo_object_init = osp_object_init,
2291 .loo_object_free = osp_object_free,
2292 .loo_object_release = osp_object_release,
2293 .loo_object_print = osp_object_print,
2294 .loo_object_invariant = osp_object_invariant