Whamcloud - gitweb
LU-5710 all: second batch of corrected typos and grammar errors
[fs/lustre-release.git] / lustre / osp / osp_object.c
index ce034ed..e838544 100644 (file)
  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2012, 2013, Intel Corporation.
+ * Copyright (c) 2014, Intel Corporation.
  */
 /*
- * This file is part of Lustre, http://www.lustre.org/
- * Lustre is a trademark of Sun Microsystems, Inc.
- *
  * lustre/osp/osp_object.c
  *
- * Lustre OST Proxy Device
+ * Lustre OST Proxy Device (OSP) is the agent on the local MDT for the OST
+ * or remote MDT.
+ *
+ * OSP object attributes cache
+ * ---------------------------
+ * OSP object is the stub of the remote OST-object or MDT-object. Both the
+ * attribute and the extended attributes are stored on the peer side remotely.
+ * It is inefficient to send RPC to peer to fetch those attributes when every
+ * get_attr()/get_xattr() called. For a large system, the LFSCK synchronous
+ * mode scanning is prohibitively inefficient.
+ *
+ * So the OSP maintains the OSP object attributes cache to cache some
+ * attributes on the local MDT. The cache is organized against the OSP
+ * object as follows:
+ *
+ * struct osp_xattr_entry {
+ *     struct list_head         oxe_list;
+ *     atomic_t                 oxe_ref;
+ *     void                    *oxe_value;
+ *     int                      oxe_buflen;
+ *     int                      oxe_namelen;
+ *     int                      oxe_vallen;
+ *     unsigned int             oxe_exist:1,
+ *                              oxe_ready:1;
+ *     char                     oxe_buf[0];
+ * };
+ *
+ * struct osp_object_attr {
+ *     struct lu_attr          ooa_attr;
+ *     struct list_head        ooa_xattr_list;
+ * };
+ *
+ * struct osp_object {
+ *     ...
+ *     struct osp_object_attr *opo_ooa;
+ *     spinlock_t              opo_lock;
+ *     ...
+ * };
+ *
+ * The basic attributes, such as owner/mode/flags, are stored in the
+ * osp_object_attr::ooa_attr. The extended attributes will be stored
+ * as osp_xattr_entry. Every extended attribute has an independent
+ * osp_xattr_entry, and all the osp_xattr_entry are linked into the
+ * osp_object_attr::ooa_xattr_list. The OSP object attributes cache
+ * is protected by the osp_object::opo_lock.
+ *
+ * Not all OSP objects have an attributes cache because maintaining
+ * the cache requires some resources. Currently, the OSP object
+ * attributes cache will be initialized when the attributes or the
+ * extended attributes are pre-fetched via osp_declare_attr_get()
+ * or osp_declare_xattr_get(). That is usually for LFSCK purpose,
+ * but it also can be shared by others.
+ *
+ *
+ * XXX: NOT prepare out RPC for remote transaction. ((please refer to the
+ *     comment of osp_trans_create() for remote transaction)
+ *
+ * According to our current transaction/dt_object_lock framework (to make
+ * the cross-MDTs modification for DNE1 to be workable), the transaction
+ * sponsor will start the transaction firstly, then try to acquire related
+ * dt_object_lock if needed. Under such rules, if we want to prepare the
+ * OUT RPC in the transaction declare phase, then related attr/xattr
+ * should be known without dt_object_lock. But such condition maybe not
+ * true for some remote transaction case. For example:
+ *
+ * For linkEA repairing (by LFSCK) case, before the LFSCK thread obtained
+ * the dt_object_lock on the target MDT-object, it cannot know whether
+ * the MDT-object has linkEA or not, neither invalid or not.
+ *
+ * Since the LFSCK thread cannot hold dt_object_lock before the remote
+ * transaction start (otherwise there will be some potential deadlock),
+ * it cannot prepare related OUT RPC for repairing during the declare
+ * phase as other normal transactions do.
+ *
+ * To resolve the trouble, we will make OSP to prepare related OUT RPC
+ * after remote transaction started, and trigger the remote updating
+ * (send RPC) when trans_stop. Then the up layer users, such as LFSCK,
+ * can follow the general rule to handle trans_start/dt_object_lock
+ * for repairing linkEA inconsistency without distinguishing remote
+ * MDT-object.
+ *
+ * In fact, above solution for remote transaction should be the normal
+ * model without considering DNE1. The trouble brought by DNE1 will be
+ * resolved in DNE2. At that time, this patch can be removed.
+ *
  *
  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
  * Author: Mikhail Pershin <mike.tappro@intel.com>
@@ -55,6 +136,16 @@ static inline bool is_ost_obj(struct lu_object *lo)
        return !lu2osp_dev(lo->lo_dev)->opd_connect_mdt;
 }
 
+/**
+ * Assign FID to the OST object.
+ *
+ * This function will assign the FID to the OST object of a striped file.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] d                pointer to the OSP device
+ * \param[in] o                pointer to the OSP object that the FID will be
+ *                     assigned to
+ */
 static void osp_object_assign_fid(const struct lu_env *env,
                                  struct osp_device *d, struct osp_object *o)
 {
@@ -69,6 +160,14 @@ static void osp_object_assign_fid(const struct lu_env *env,
        lu_object_assign_fid(env, &o->opo_obj.do_lu, &osi->osi_fid);
 }
 
+/**
+ * Initialize the OSP object attributes cache.
+ *
+ * \param[in] obj      pointer to the OSP object
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_oac_init(struct osp_object *obj)
 {
        struct osp_object_attr *ooa;
@@ -90,6 +189,20 @@ static int osp_oac_init(struct osp_object *obj)
        return 0;
 }
 
+/**
+ * Find the named extended attribute in the OSP object attributes cache.
+ *
+ * The caller should take the osp_object::opo_lock before calling
+ * this function.
+ *
+ * \param[in] ooa      pointer to the OSP object attributes cache
+ * \param[in] name     the name of the extended attribute
+ * \param[in] namelen  the name length of the extended attribute
+ *
+ * \retval             pointer to the found extended attribute entry
+ * \retval             NULL if the specified extended attribute is not
+ *                     in the cache
+ */
 static struct osp_xattr_entry *
 osp_oac_xattr_find_locked(struct osp_object_attr *ooa,
                          const char *name, size_t namelen)
@@ -105,6 +218,20 @@ osp_oac_xattr_find_locked(struct osp_object_attr *ooa,
        return NULL;
 }
 
+/**
+ * Find the named extended attribute in the OSP object attributes cache.
+ *
+ * Call osp_oac_xattr_find_locked() with the osp_object::opo_lock held.
+ *
+ * \param[in] obj      pointer to the OSP object
+ * \param[in] name     the name of the extended attribute
+ * \param[in] unlink   true if the extended attribute entry is to be removed
+ *                     from the cache
+ *
+ * \retval             pointer to the found extended attribute entry
+ * \retval             NULL if the specified extended attribute is not
+ *                     in the cache
+ */
 static struct osp_xattr_entry *osp_oac_xattr_find(struct osp_object *obj,
                                                  const char *name, bool unlink)
 {
@@ -126,6 +253,21 @@ static struct osp_xattr_entry *osp_oac_xattr_find(struct osp_object *obj,
        return oxe;
 }
 
+/**
+ * Find the named extended attribute in the OSP object attributes cache.
+ *
+ * If it is not in the cache, then add an empty entry (that will be
+ * filled later) to cache with the given name.
+ *
+ * \param[in] obj      pointer to the OSP object
+ * \param[in] name     the name of the extended attribute
+ * \param[in] len      the length of the extended attribute value
+ *
+ * \retval             pointer to the found or new-created extended
+ *                     attribute entry
+ * \retval             NULL if the specified extended attribute is not in the
+ *                     cache or fail to add new empty entry to the cache.
+ */
 static struct osp_xattr_entry *
 osp_oac_xattr_find_or_add(struct osp_object *obj, const char *name, size_t len)
 {
@@ -169,6 +311,23 @@ osp_oac_xattr_find_or_add(struct osp_object *obj, const char *name, size_t len)
        return oxe;
 }
 
+/**
+ * Add the given extended attribute to the OSP object attributes cache.
+ *
+ * If there is an old extended attributed entry with the same name,
+ * remove it from the cache and return it via the parameter \a poxe.
+ *
+ * \param[in] obj      pointer to the OSP object
+ * \param[in,out] poxe double pointer to the OSP object extended attribute
+ *                     entry: the new extended attribute entry is transferred
+ *                     via such pointer target, and if old the extended
+ *                     attribute entry exists, then it will be returned back
+ *                     via such pointer target.
+ * \param[in] len      the length of the (new) extended attribute value
+ *
+ * \retval             pointer to the new extended attribute entry
+ * \retval             NULL for failure cases.
+ */
 static struct osp_xattr_entry *
 osp_oac_xattr_replace(struct osp_object *obj,
                      struct osp_xattr_entry **poxe, size_t len)
@@ -203,6 +362,13 @@ osp_oac_xattr_replace(struct osp_object *obj,
        return oxe;
 }
 
+/**
+ * Release reference from the OSP object extended attribute entry.
+ *
+ * If it is the last reference, then free the entry.
+ *
+ * \param[in] oxe      pointer to the OSP object extended attribute entry.
+ */
 static inline void osp_oac_xattr_put(struct osp_xattr_entry *oxe)
 {
        if (atomic_dec_and_test(&oxe->oxe_ref)) {
@@ -212,6 +378,22 @@ static inline void osp_oac_xattr_put(struct osp_xattr_entry *oxe)
        }
 }
 
+/**
+ * Parse the OSP object attribute from the RPC reply.
+ *
+ * If the attribute is valid, then it will be added to the OSP object
+ * attributes cache.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] reply    pointer to the RPC reply
+ * \param[in] req      pointer to the RPC request
+ * \param[out] attr    pointer to buffer to hold the output attribute
+ * \param[in] obj      pointer to the OSP object
+ * \param[in] index    the index of the attribute buffer in the reply
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_get_attr_from_reply(const struct lu_env *env,
                                   struct object_update_reply *reply,
                                   struct ptlrpc_request *req,
@@ -252,6 +434,23 @@ static int osp_get_attr_from_reply(const struct lu_env *env,
        return 0;
 }
 
+/**
+ * Interpreter function for getting OSP object attribute asynchronously.
+ *
+ * Called to interpret the result of an async mode RPC for getting the
+ * OSP object attribute.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] reply    pointer to the RPC reply
+ * \param[in] req      pointer to the RPC request
+ * \param[in] obj      pointer to the OSP object
+ * \param[out] data    pointer to buffer to hold the output attribute
+ * \param[in] index    the index of the attribute buffer in the reply
+ * \param[in] rc       the result for handling the RPC
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_attr_get_interpterer(const struct lu_env *env,
                                    struct object_update_reply *reply,
                                    struct ptlrpc_request *req,
@@ -282,8 +481,23 @@ static int osp_attr_get_interpterer(const struct lu_env *env,
        return 0;
 }
 
-static int osp_declare_attr_get(const struct lu_env *env, struct dt_object *dt,
-                               struct lustre_capa *capa)
+/**
+ * Implement OSP layer dt_object_operations::do_declare_attr_get() interface.
+ *
+ * Declare that the caller will get attribute from the specified OST object.
+ *
+ * This function adds an Object Unified Target (OUT) sub-request to the per-OSP
+ * based shared asynchronous request queue. The osp_attr_get_interpterer()
+ * is registered as the interpreter function to handle the result of this
+ * sub-request.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+static int osp_declare_attr_get(const struct lu_env *env, struct dt_object *dt)
 {
        struct osp_object       *obj    = dt2osp_obj(dt);
        struct osp_device       *osp    = lu2osp_dev(dt->do_lu.lo_dev);
@@ -304,8 +518,25 @@ static int osp_declare_attr_get(const struct lu_env *env, struct dt_object *dt,
        return rc;
 }
 
+/**
+ * Implement OSP layer dt_object_operations::do_attr_get() interface.
+ *
+ * Get attribute from the specified MDT/OST object.
+ *
+ * If the attribute is in the OSP object attributes cache, then return
+ * the cached attribute directly. Otherwise it will trigger an OUT RPC
+ * to the peer to get the attribute synchronously, if successful, add it
+ * to the OSP attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[out] attr    pointer to the buffer to hold the output attribute
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
-                struct lu_attr *attr, struct lustre_capa *capa)
+                struct lu_attr *attr)
 {
        struct osp_device               *osp = lu2osp_dev(dt->do_lu.lo_dev);
        struct osp_object               *obj = dt2osp_obj(dt);
@@ -344,7 +575,7 @@ int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
                GOTO(out, rc);
        }
 
-       rc = out_remote_sync(env, osp->opd_obd->u.cli.cl_import, update, &req);
+       rc = osp_remote_sync(env, osp, update, &req);
        if (rc != 0) {
                if (rc == -ENOENT) {
                        osp2lu_obj(obj)->lo_header->loh_attr &= ~LOHA_EXISTS;
@@ -381,19 +612,33 @@ out:
        return rc;
 }
 
-static int __osp_attr_set(const struct lu_env *env, struct dt_object *dt,
-                         const struct lu_attr *attr, struct thandle *th)
+/**
+ * Implement OSP layer dt_object_operations::do_declare_attr_set() interface.
+ *
+ * If the transaction is not remote one, then declare the credits that will
+ * be used for the subsequent llog record for the object's attributes.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] attr     pointer to the attribute to be set
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+static int osp_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
+                               const struct lu_attr *attr, struct thandle *th)
 {
        struct osp_device       *d = lu2osp_dev(dt->do_lu.lo_dev);
        struct osp_object       *o = dt2osp_obj(dt);
-       struct lu_attr          *la;
-       int                      rc = 0;
-       ENTRY;
+       int                     rc;
 
+       if (is_only_remote_trans(th))
+               return osp_md_declare_attr_set(env, dt, attr, th);
        /*
         * Usually we don't allow server stack to manipulate size
         * but there is a special case when striping is created
-        * late, after stripless file got truncated to non-zero.
+        * late, after stripeless file got truncated to non-zero.
         *
         * In this case we do the following:
         *
@@ -418,131 +663,101 @@ static int __osp_attr_set(const struct lu_env *env, struct dt_object *dt,
                LASSERT(!dt_object_exists(dt));
                osp_object_assign_fid(env, d, o);
                rc = osp_object_truncate(env, dt, attr->la_size);
-               if (rc)
+               if (rc != 0)
                        RETURN(rc);
        }
 
-       if (o->opo_new)
-               /* no need in logging for new objects being created */
-               RETURN(0);
-
        if (!(attr->la_valid & (LA_UID | LA_GID)))
                RETURN(0);
 
-       if (!is_only_remote_trans(th))
-               /*
-                * track all UID/GID changes via llog
-                */
-               rc = osp_sync_declare_add(env, o, MDS_SETATTR64_REC, th);
-       else
-               /* It is for OST-object attr_set directly without updating
-                * local MDT-object attribute. It is usually used by LFSCK. */
-               rc = osp_md_declare_attr_set(env, dt, attr, th);
-
-       if (rc != 0 || o->opo_ooa == NULL)
-               RETURN(rc);
-
-       /* Update the OSP object attributes cache. */
-       la = &o->opo_ooa->ooa_attr;
-       spin_lock(&o->opo_lock);
-       if (attr->la_valid & LA_UID) {
-               la->la_uid = attr->la_uid;
-               la->la_valid |= LA_UID;
-       }
-
-       if (attr->la_valid & LA_GID) {
-               la->la_gid = attr->la_gid;
-               la->la_valid |= LA_GID;
-       }
-       spin_unlock(&o->opo_lock);
+       /* track all UID/GID changes via llog */
+       rc = osp_sync_declare_add(env, o, MDS_SETATTR64_REC, th);
 
-       RETURN(0);
+       return 0;
 }
 
 /**
- * XXX: NOT prepare set_{attr,xattr} RPC for remote transaction.
+ * Implement OSP layer dt_object_operations::do_attr_set() interface.
  *
- * According to our current transaction/dt_object_lock framework (to make
- * the cross-MDTs modification for DNE1 to be workable), the transaction
- * sponsor will start the transaction firstly, then try to acquire related
- * dt_object_lock if needed. Under such rules, if we want to prepare the
- * set_{attr,xattr} RPC in the RPC declare phase, then related attr/xattr
- * should be known without dt_object_lock. But such condition maybe not
- * true for some remote transaction case. For example:
+ * Set attribute to the specified OST object.
  *
- * For linkEA repairing (by LFSCK) case, before the LFSCK thread obtained
- * the dt_object_lock on the target MDT-object, it cannot know whether
- * the MDT-object has linkEA or not, neither invalid or not.
+ * If the transaction is a remote one, then add OUT_ATTR_SET sub-request
+ * in the OUT RPC that will be flushed when the remote transaction stop.
+ * Otherwise, it will generate a MDS_SETATTR64_REC record in the llog that
+ * will be handled by a dedicated thread asynchronously.
  *
- * Since the LFSCK thread cannot hold dt_object_lock before the (remote)
- * transaction start (otherwise there will be some potential deadlock),
- * it cannot prepare related RPC for repairing during the declare phase
- * as other normal transactions do.
+ * If the attribute entry exists in the OSP object attributes cache,
+ * then update the cached attribute according to given attribute.
  *
- * To resolve the trouble, we will make OSP to prepare related RPC
- * (set_attr/set_xattr/del_xattr) after remote transaction started,
- * and trigger the remote updating (RPC sending) when trans_stop.
- * Then the up layer users, such as LFSCK, can follow the general
- * rule to handle trans_start/dt_object_lock for repairing linkEA
- * inconsistency without distinguishing remote MDT-object.
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] attr     pointer to the attribute to be set
+ * \param[in] th       pointer to the transaction handler
  *
- * In fact, above solution for remote transaction should be the normal
- * model without considering DNE1. The trouble brought by DNE1 will be
- * resolved in DNE2. At that time, this patch can be removed.
+ * \retval             0 for success
+ * \retval             negative error number on failure
  */
-static int osp_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
-                               const struct lu_attr *attr, struct thandle *th)
-{
-       int rc = 0;
-
-       if (!is_only_remote_trans(th))
-               rc = __osp_attr_set(env, dt, attr, th);
-
-       return rc;
-}
-
 static int osp_attr_set(const struct lu_env *env, struct dt_object *dt,
-                       const struct lu_attr *attr, struct thandle *th,
-                       struct lustre_capa *capa)
+                       const struct lu_attr *attr, struct thandle *th)
 {
        struct osp_object       *o = dt2osp_obj(dt);
        int                      rc = 0;
        ENTRY;
 
-       if (is_only_remote_trans(th)) {
-               rc = __osp_attr_set(env, dt, attr, th);
-               if (rc != 0)
-                       RETURN(rc);
-       }
-
        /* we're interested in uid/gid changes only */
        if (!(attr->la_valid & (LA_UID | LA_GID)))
                RETURN(0);
 
-       /* new object, the very first ->attr_set()
-        * initializing attributes needs no logging
-        * all subsequent one are subject to the
-        * logging and synchronization with OST */
-       if (o->opo_new) {
-               o->opo_new = 0;
-               RETURN(0);
-       }
-
-       if (!is_only_remote_trans(th))
-               /*
-                * once transaction is committed put proper command on
-                * the queue going to our OST
-                */
+       if (!is_only_remote_trans(th)) {
                rc = osp_sync_add(env, o, MDS_SETATTR64_REC, th, attr);
                /* XXX: send new uid/gid to OST ASAP? */
-       else
+       } else {
+               struct lu_attr  *la;
+
                /* It is for OST-object attr_set directly without updating
                 * local MDT-object attribute. It is usually used by LFSCK. */
-               rc = osp_md_attr_set(env, dt, attr, th, capa);
+               rc = osp_md_attr_set(env, dt, attr, th);
+               CDEBUG(D_INFO, "(1) set attr "DFID": rc = %d\n",
+                      PFID(&dt->do_lu.lo_header->loh_fid), rc);
+
+               if (rc != 0 || o->opo_ooa == NULL)
+                       RETURN(rc);
+
+               /* Update the OSP object attributes cache. */
+               la = &o->opo_ooa->ooa_attr;
+               spin_lock(&o->opo_lock);
+               if (attr->la_valid & LA_UID) {
+                       la->la_uid = attr->la_uid;
+                       la->la_valid |= LA_UID;
+               }
+
+               if (attr->la_valid & LA_GID) {
+                       la->la_gid = attr->la_gid;
+                       la->la_valid |= LA_GID;
+               }
+               spin_unlock(&o->opo_lock);
+       }
 
        RETURN(rc);
 }
 
+/**
+ * Interpreter function for getting OSP object extended attribute asynchronously
+ *
+ * Called to interpret the result of an async mode RPC for getting the
+ * OSP object extended attribute.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] reply    pointer to the RPC reply
+ * \param[in] req      pointer to the RPC request
+ * \param[in] obj      pointer to the OSP object
+ * \param[out] data    pointer to OSP object attributes cache
+ * \param[in] index    the index of the attribute buffer in the reply
+ * \param[in] rc       the result for handling the RPC
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_xattr_get_interpterer(const struct lu_env *env,
                                     struct object_update_reply *reply,
                                     struct ptlrpc_request *req,
@@ -590,9 +805,26 @@ static int osp_xattr_get_interpterer(const struct lu_env *env,
        return 0;
 }
 
+/**
+ * Implement OSP dt_object_operations::do_declare_xattr_get() interface.
+ *
+ * Declare that the caller will get extended attribute from the specified
+ * OST object.
+ *
+ * This function will add an OUT_XATTR_GET sub-request to the per OSP
+ * based shared asynchronous request queue with the interpreter function:
+ * osp_xattr_get_interpterer().
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[out] buf     pointer to the lu_buf to hold the extended attribute
+ * \param[in] name     the name for the expected extended attribute
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_declare_xattr_get(const struct lu_env *env, struct dt_object *dt,
-                                struct lu_buf *buf, const char *name,
-                                struct lustre_capa *capa)
+                                struct lu_buf *buf, const char *name)
 {
        struct osp_object       *obj     = dt2osp_obj(dt);
        struct osp_device       *osp     = lu2osp_dev(dt->do_lu.lo_dev);
@@ -646,9 +878,31 @@ static int osp_declare_xattr_get(const struct lu_env *env, struct dt_object *dt,
        return rc;
 }
 
+/**
+ * Implement OSP layer dt_object_operations::do_xattr_get() interface.
+ *
+ * Get extended attribute from the specified MDT/OST object.
+ *
+ * If the extended attribute is in the OSP object attributes cache, then
+ * return the cached extended attribute directly. Otherwise it will get
+ * the extended attribute synchronously, if successful, add it to the OSP
+ * attributes cache. (\see lustre/osp/osp_trans.c for OUT RPC.)
+ *
+ * There is a race condition: some other thread has added the named extended
+ * attributed entry to the OSP object attributes cache during the current
+ * OUT_XATTR_GET handling. If such case happens, the OSP will replace the
+ * (just) existing extended attribute entry with the new replied one.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[out] buf     pointer to the lu_buf to hold the extended attribute
+ * \param[in] name     the name for the expected extended attribute
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
-                 struct lu_buf *buf, const char *name,
-                 struct lustre_capa *capa)
+                 struct lu_buf *buf, const char *name)
 {
        struct osp_device       *osp    = lu2osp_dev(dt->do_lu.lo_dev);
        struct osp_object       *obj    = dt2osp_obj(dt);
@@ -666,9 +920,15 @@ int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
        LASSERT(name != NULL);
 
        if (OBD_FAIL_CHECK(OBD_FAIL_LFSCK_BAD_NETWORK) &&
-           osp->opd_index == cfs_fail_val &&
-           osp_dev2node(osp) == cfs_fail_val)
-               RETURN(-ENOTCONN);
+           osp->opd_index == cfs_fail_val) {
+               if (is_ost_obj(&dt->do_lu)) {
+                       if (osp_dev2node(osp) == cfs_fail_val)
+                               RETURN(-ENOTCONN);
+               } else {
+                       if (strcmp(name, XATTR_NAME_LINK) == 0)
+                               RETURN(-ENOTCONN);
+               }
+       }
 
        if (unlikely(obj->opo_non_exist))
                RETURN(-ENOENT);
@@ -711,8 +971,13 @@ unlock:
                GOTO(out, rc);
        }
 
-       rc = out_remote_sync(env, osp->opd_obd->u.cli.cl_import, update, &req);
+       rc = osp_remote_sync(env, osp, update, &req);
        if (rc != 0) {
+               if (rc == -ENOENT) {
+                       dt->do_lu.lo_header->loh_attr &= ~LOHA_EXISTS;
+                       obj->opo_non_exist = 1;
+               }
+
                if (obj->opo_ooa == NULL)
                        GOTO(out, rc);
 
@@ -820,9 +1085,60 @@ out:
        return rc;
 }
 
-static int __osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
-                          const struct lu_buf *buf, const char *name,
-                          int flag, struct thandle *th)
+/**
+ * Implement OSP layer dt_object_operations::do_declare_xattr_set() interface.
+ *
+ * Declare that the caller will set extended attribute to the specified
+ * MDT/OST object.
+ *
+ * If it is non-remote transaction, it will add an OUT_XATTR_SET sub-request
+ * to the OUT RPC that will be flushed when the transaction start. And if the
+ * OSP attributes cache is initialized, then check whether the name extended
+ * attribute entry exists in the cache or not. If yes, replace it; otherwise,
+ * add the extended attribute to the cache.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] buf      pointer to the lu_buf to hold the extended attribute
+ * \param[in] name     the name of the extended attribute to be set
+ * \param[in] flag     to indicate the detailed set operation: LU_XATTR_CREATE
+ *                     or LU_XATTR_REPLACE or others
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
+                         const struct lu_buf *buf, const char *name,
+                         int flag, struct thandle *th)
+{
+       return osp_trans_update_request_create(th);
+}
+
+/**
+ * Implement OSP layer dt_object_operations::do_xattr_set() interface.
+ *
+ * Set extended attribute to the specified MDT/OST object.
+ *
+ * Add an OUT_XATTR_SET sub-request into the OUT RPC that will be flushed in
+ * the transaction stop. And if the OSP attributes cache is initialized, then
+ * check whether the name extended attribute entry exists in the cache or not.
+ * If yes, replace it; otherwise, add the extended attribute to the cache.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] buf      pointer to the lu_buf to hold the extended attribute
+ * \param[in] name     the name of the extended attribute to be set
+ * \param[in] fl       to indicate the detailed set operation: LU_XATTR_CREATE
+ *                     or LU_XATTR_REPLACE or others
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
+                 const struct lu_buf *buf, const char *name, int fl,
+                 struct thandle *th)
 {
        struct osp_object       *o = dt2osp_obj(dt);
        struct dt_update_request *update;
@@ -831,26 +1147,21 @@ static int __osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
        ENTRY;
 
        LASSERT(buf->lb_len > 0 && buf->lb_buf != NULL);
+       update = thandle_to_dt_update_request(th);
+       LASSERT(update != NULL);
 
-       update = dt_update_request_find_or_create(th, dt);
-       if (IS_ERR(update)) {
-               CERROR("%s: Get OSP update buf failed "DFID": rc = %d\n",
-                      dt->do_lu.lo_dev->ld_obd->obd_name,
-                      PFID(lu_object_fid(&dt->do_lu)),
-                      (int)PTR_ERR(update));
-
-               RETURN(PTR_ERR(update));
-       }
+       CDEBUG(D_INODE, DFID" set xattr '%s' with size %zd\n",
+              PFID(lu_object_fid(&dt->do_lu)), name, buf->lb_len);
 
        rc = out_xattr_set_pack(env, &update->dur_buf,
                                lu_object_fid(&dt->do_lu),
-                               buf, name, flag, update->dur_batchid);
+                               buf, name, fl, update->dur_batchid);
        if (rc != 0 || o->opo_ooa == NULL)
-               RETURN(rc);
+               return rc;
 
        oxe = osp_oac_xattr_find_or_add(o, name, buf->lb_len);
        if (oxe == NULL) {
-               CWARN("%s: Fail to add xattr (%s) to cache for "DFID,
+               CWARN("%s: cannot cache xattr '%s' of "DFID"\n",
                      dt->do_lu.lo_dev->ld_obd->obd_name,
                      name, PFID(lu_object_fid(&dt->do_lu)));
 
@@ -865,7 +1176,7 @@ static int __osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
                osp_oac_xattr_put(oxe);
                oxe = tmp;
                if (tmp == NULL) {
-                       CWARN("%s: Fail to update xattr (%s) to cache for "DFID,
+                       CWARN("%s: cannot update cached xattr '%s' of "DFID"\n",
                              dt->do_lu.lo_dev->ld_obd->obd_name,
                              name, PFID(lu_object_fid(&dt->do_lu)));
                        spin_lock(&o->opo_lock);
@@ -890,55 +1201,63 @@ static int __osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
        RETURN(0);
 }
 
-int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
-                         const struct lu_buf *buf, const char *name,
-                         int flag, struct thandle *th)
-{
-       int rc = 0;
-
-       /* Please check the comment in osp_attr_set() for handling
-        * remote transaction. */
-       if (!is_only_remote_trans(th))
-               rc = __osp_xattr_set(env, dt, buf, name, flag, th);
-
-       return rc;
-}
-
-int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
-                 const struct lu_buf *buf, const char *name, int fl,
-                 struct thandle *th, struct lustre_capa *capa)
+/**
+ * Implement OSP layer dt_object_operations::do_declare_xattr_del() interface.
+ *
+ * Declare that the caller will delete extended attribute on the specified
+ * MDT/OST object.
+ *
+ * If it is non-remote transaction, it will add an OUT_XATTR_DEL sub-request
+ * to the OUT RPC that will be flushed when the transaction start. And if the
+ * name extended attribute entry exists in the OSP attributes cache, then remove
+ * it from the cache.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] name     the name of the extended attribute to be set
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+int osp_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
+                         const char *name, struct thandle *th)
 {
-       int rc = 0;
-
-       CDEBUG(D_INFO, "xattr %s set object "DFID"\n", name,
-              PFID(&dt->do_lu.lo_header->loh_fid));
-
-       /* Please check the comment in osp_attr_set() for handling
-        * remote transaction. */
-       if (is_only_remote_trans(th))
-               rc = __osp_xattr_set(env, dt, buf, name, fl, th);
-
-       return rc;
+       return osp_trans_update_request_create(th);
 }
 
-static int __osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
-                          const char *name, struct thandle *th)
+/**
+ * Implement OSP layer dt_object_operations::do_xattr_del() interface.
+ *
+ * Delete extended attribute on the specified MDT/OST object.
+ *
+ * If it is remote transaction, it will add an OUT_XATTR_DEL sub-request into
+ * the OUT RPC that will be flushed when the transaction stop. And if the name
+ * extended attribute entry exists in the OSP attributes cache, then remove it
+ * from the cache.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] name     the name of the extended attribute to be set
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+int osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
+                 const char *name, struct thandle *th)
 {
        struct dt_update_request *update;
-       const struct lu_fid      *fid;
-       struct osp_object        *o     = dt2osp_obj(dt);
+       const struct lu_fid      *fid = lu_object_fid(&dt->do_lu);
+       struct osp_object        *o = dt2osp_obj(dt);
        struct osp_xattr_entry   *oxe;
        int                       rc;
 
-       update = dt_update_request_find_or_create(th, dt);
-       if (IS_ERR(update))
-               return PTR_ERR(update);
-
-       fid = lu_object_fid(&dt->do_lu);
+       update = thandle_to_dt_update_request(th);
+       LASSERT(update != NULL);
 
        rc = out_xattr_del_pack(env, &update->dur_buf, fid, name,
                                update->dur_batchid);
-
        if (rc != 0 || o->opo_ooa == NULL)
                return rc;
 
@@ -950,36 +1269,30 @@ static int __osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
        return 0;
 }
 
-int osp_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
-                         const char *name, struct thandle *th)
-{
-       int rc = 0;
-
-       /* Please check the comment in osp_attr_set() for handling
-        * remote transaction. */
-       if (!is_only_remote_trans(th))
-               rc = __osp_xattr_del(env, dt, name, th);
-
-       return rc;
-}
-
-int osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
-                 const char *name, struct thandle *th,
-                 struct lustre_capa *capa)
-{
-       int rc = 0;
-
-       CDEBUG(D_INFO, "xattr %s del object "DFID"\n", name,
-              PFID(&dt->do_lu.lo_header->loh_fid));
-
-       /* Please check the comment in osp_attr_set() for handling
-        * remote transaction. */
-       if (is_only_remote_trans(th))
-               rc = __osp_xattr_del(env, dt, name, th);
-
-       return rc;
-}
-
+/**
+ * Implement OSP layer dt_object_operations::do_declare_create() interface.
+ *
+ * Declare that the caller will create the OST object.
+ *
+ * If the transaction is a remote transaction and the FID for the OST-object
+ * has been assigned already, then handle it as creating (remote) MDT object
+ * via osp_md_declare_object_create(). This function is usually used for LFSCK
+ * to re-create the lost OST object. Otherwise, if it is not replay case, the
+ * OSP will reserve pre-created object for the subsequent create operation;
+ * if the MDT side cached pre-created objects are less than some threshold,
+ * then it will wakeup the pre-create thread.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] attr     the attribute for the object to be created
+ * \param[in] hint     pointer to the hint for creating the object, such as
+ *                     the parent object
+ * \param[in] dof      pointer to the dt_object_format for help the creation
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_declare_object_create(const struct lu_env *env,
                                     struct dt_object *dt,
                                     struct lu_attr *attr,
@@ -991,11 +1304,12 @@ static int osp_declare_object_create(const struct lu_env *env,
        struct osp_device       *d = lu2osp_dev(dt->do_lu.lo_dev);
        struct osp_object       *o = dt2osp_obj(dt);
        const struct lu_fid     *fid = lu_object_fid(&dt->do_lu);
+       struct thandle          *local_th;
        int                      rc = 0;
 
        ENTRY;
 
-       if (is_only_remote_trans(th)) {
+       if (is_only_remote_trans(th) && !fid_is_zero(fid)) {
                LASSERT(fid_is_sane(fid));
 
                rc = osp_md_declare_object_create(env, dt, attr, hint, dof, th);
@@ -1019,13 +1333,19 @@ static int osp_declare_object_create(const struct lu_env *env,
         */
        /* rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th); */
 
+       local_th = osp_get_storage_thandle(env, th, d);
+       if (IS_ERR(local_th))
+               RETURN(PTR_ERR(local_th));
+
        if (unlikely(!fid_is_zero(fid))) {
                /* replay case: caller knows fid */
                osi->osi_off = sizeof(osi->osi_id) * d->opd_index;
                osi->osi_lb.lb_len = sizeof(osi->osi_id);
                osi->osi_lb.lb_buf = NULL;
+
                rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
-                                            &osi->osi_lb, osi->osi_off, th);
+                                            &osi->osi_lb, osi->osi_off,
+                                            local_th);
                RETURN(rc);
        }
 
@@ -1050,7 +1370,8 @@ static int osp_declare_object_create(const struct lu_env *env,
                osi->osi_lb.lb_len = sizeof(osi->osi_id);
                osi->osi_lb.lb_buf = NULL;
                rc = dt_declare_record_write(env, d->opd_last_used_oid_file,
-                                            &osi->osi_lb, osi->osi_off, th);
+                                            &osi->osi_lb, osi->osi_off,
+                                            local_th);
        } else {
                /* not needed in the cache anymore */
                set_bit(LU_OBJECT_HEARD_BANSHEE,
@@ -1059,6 +1380,27 @@ static int osp_declare_object_create(const struct lu_env *env,
        RETURN(rc);
 }
 
+/**
+ * Implement OSP layer dt_object_operations::do_create() interface.
+ *
+ * Create the OST object.
+ *
+ * If the transaction is a remote transaction and the FID for the OST-object
+ * has been assigned already, then handle it as handling MDT object via the
+ * osp_md_object_create(). For other cases, the OSP will assign FID to the
+ * object to be created, and update last_used Object ID (OID) file.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] attr     the attribute for the object to be created
+ * \param[in] hint     pointer to the hint for creating the object, such as
+ *                     the parent object
+ * \param[in] dof      pointer to the dt_object_format for help the creation
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
                             struct lu_attr *attr,
                             struct dt_allocation_hint *hint,
@@ -1069,9 +1411,11 @@ static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
        struct osp_object       *o = dt2osp_obj(dt);
        int                     rc = 0;
        struct lu_fid           *fid = &osi->osi_fid;
+       struct thandle          *local_th;
        ENTRY;
 
-       if (is_only_remote_trans(th)) {
+       if (is_only_remote_trans(th) &&
+           !fid_is_zero(lu_object_fid(&dt->do_lu))) {
                LASSERT(fid_is_sane(lu_object_fid(&dt->do_lu)));
 
                rc = osp_md_object_create(env, dt, attr, hint, dof, th);
@@ -1083,7 +1427,7 @@ static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
 
        o->opo_non_exist = 0;
        if (o->opo_reserved) {
-               /* regular case, fid is assigned holding trunsaction open */
+               /* regular case, fid is assigned holding transaction open */
                 osp_object_assign_fid(env, d, o);
        }
 
@@ -1110,6 +1454,9 @@ static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
        if (osp_precreate_end_seq(env, d) && osp_is_fid_client(d))
                th->th_sync = 1;
 
+       local_th = osp_get_storage_thandle(env, th, d);
+       if (IS_ERR(local_th))
+               RETURN(PTR_ERR(local_th));
        /*
         * it's OK if the import is inactive by this moment - id was created
         * by OST earlier, we just need to maintain it consistently on the disk
@@ -1129,7 +1476,7 @@ static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
                        d->opd_gap_count = 0;
                        spin_unlock(&d->opd_pre_lock);
 
-                       CDEBUG(D_HA, "Writting gap "DFID"+%d in llog\n",
+                       CDEBUG(D_HA, "Writing gap "DFID"+%d in llog\n",
                               PFID(&d->opd_gap_start_fid), count);
                        /* real gap handling is disabled intil ORI-692 will be
                         * fixed, now we only report gaps */
@@ -1138,17 +1485,13 @@ static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
                }
        }
 
-       /* new object, the very first ->attr_set()
-        * initializing attributes needs no logging */
-       o->opo_new = 1;
-
        /* Only need update last_used oid file, seq file will only be update
         * during seq rollover */
        osp_objid_buf_prep(&osi->osi_lb, &osi->osi_off,
                           &d->opd_last_used_fid.f_oid, d->opd_index);
 
        rc = dt_record_write(env, d->opd_last_used_oid_file, &osi->osi_lb,
-                            &osi->osi_off, th);
+                            &osi->osi_off, local_th);
 
        CDEBUG(D_HA, "%s: Wrote last used FID: "DFID", index %d: %d\n",
               d->opd_obd->obd_name, PFID(fid), d->opd_index, rc);
@@ -1156,36 +1499,69 @@ static int osp_object_create(const struct lu_env *env, struct dt_object *dt,
        RETURN(rc);
 }
 
+/**
+ * Implement OSP layer dt_object_operations::do_declare_destroy() interface.
+ *
+ * Declare that the caller will destroy the specified OST object.
+ *
+ * The OST object destroy will be handled via llog asynchronously. This
+ * function will declare the credits for generating MDS_UNLINK64_REC llog.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object to be destroyed
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 int osp_declare_object_destroy(const struct lu_env *env,
                               struct dt_object *dt, struct thandle *th)
 {
        struct osp_object       *o = dt2osp_obj(dt);
+       struct osp_device       *osp = lu2osp_dev(dt->do_lu.lo_dev);
        int                      rc = 0;
 
        ENTRY;
 
-       /*
-        * track objects to be destroyed via llog
-        */
+       LASSERT(!osp->opd_connect_mdt);
        rc = osp_sync_declare_add(env, o, MDS_UNLINK64_REC, th);
 
        RETURN(rc);
 }
 
-int osp_object_destroy(const struct lu_env *env, struct dt_object *dt,
-                      struct thandle *th)
+/**
+ * Implement OSP layer dt_object_operations::do_destroy() interface.
+ *
+ * Destroy the specified OST object.
+ *
+ * The OSP generates a MDS_UNLINK64_REC record in the llog. There
+ * will be some dedicated thread to handle the llog asynchronously.
+ *
+ * It also marks the object as non-cached.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object to be destroyed
+ * \param[in] th       pointer to the transaction handler
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+static int osp_object_destroy(const struct lu_env *env, struct dt_object *dt,
+                             struct thandle *th)
 {
        struct osp_object       *o = dt2osp_obj(dt);
+       struct osp_device       *osp = lu2osp_dev(dt->do_lu.lo_dev);
        int                      rc = 0;
 
        ENTRY;
-
        o->opo_non_exist = 1;
-       /*
-        * once transaction is committed put proper command on
-        * the queue going to our OST
-        */
+
+       LASSERT(!osp->opd_connect_mdt);
+       /* once transaction is committed put proper command on
+        * the queue going to our OST. */
        rc = osp_sync_add(env, o, MDS_UNLINK64_REC, th, NULL);
+       if (rc < 0)
+               RETURN(rc);
 
        /* not needed in cache any more */
        set_bit(LU_OBJECT_HEARD_BANSHEE, &dt->do_lu.lo_header->loh_flags);
@@ -1196,8 +1572,7 @@ int osp_object_destroy(const struct lu_env *env, struct dt_object *dt,
 static int osp_orphan_index_lookup(const struct lu_env *env,
                                   struct dt_object *dt,
                                   struct dt_rec *rec,
-                                  const struct dt_key *key,
-                                  struct lustre_capa *capa)
+                                  const struct dt_key *key)
 {
        return -EOPNOTSUPP;
 }
@@ -1216,7 +1591,6 @@ static int osp_orphan_index_insert(const struct lu_env *env,
                                   const struct dt_rec *rec,
                                   const struct dt_key *key,
                                   struct thandle *handle,
-                                  struct lustre_capa *capa,
                                   int ignore_quota)
 {
        return -EOPNOTSUPP;
@@ -1233,14 +1607,23 @@ static int osp_orphan_index_declare_delete(const struct lu_env *env,
 static int osp_orphan_index_delete(const struct lu_env *env,
                                   struct dt_object *dt,
                                   const struct dt_key *key,
-                                  struct thandle *handle,
-                                  struct lustre_capa *capa)
+                                  struct thandle *handle)
 {
        return -EOPNOTSUPP;
 }
 
+/**
+ * Initialize the OSP layer index iteration.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the index object to be iterated
+ * \param[in] attr     unused
+ *
+ * \retval             pointer to the iteration structure
+ * \retval             negative error number on failure
+ */
 struct dt_it *osp_it_init(const struct lu_env *env, struct dt_object *dt,
-                         __u32 attr, struct lustre_capa *capa)
+                         __u32 attr)
 {
        struct osp_it *it;
 
@@ -1250,10 +1633,17 @@ struct dt_it *osp_it_init(const struct lu_env *env, struct dt_object *dt,
 
        it->ooi_pos_ent = -1;
        it->ooi_obj = dt;
+       it->ooi_attr = attr;
 
        return (struct dt_it *)it;
 }
 
+/**
+ * Finalize the OSP layer index iteration.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] di       pointer to the iteration structure
+ */
 void osp_it_fini(const struct lu_env *env, struct dt_it *di)
 {
        struct osp_it   *it = (struct osp_it *)di;
@@ -1276,6 +1666,18 @@ void osp_it_fini(const struct lu_env *env, struct dt_it *di)
        OBD_FREE_PTR(it);
 }
 
+/**
+ * Get more records for the iteration from peer.
+ *
+ * The new records will be filled in an array of pages. The OSP side
+ * allows 1MB bulk data to be transferred.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] it       pointer to the iteration structure
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_it_fetch(const struct lu_env *env, struct osp_it *it)
 {
        struct lu_device         *dev   = it->ooi_obj->do_lu.lo_dev;
@@ -1327,15 +1729,16 @@ static int osp_it_fetch(const struct lu_env *env, struct osp_it *it)
                ii->ii_fid.f_oid = osp->opd_index;
                ii->ii_fid.f_ver = 0;
                ii->ii_flags = II_FL_NOHASH;
+               ii->ii_attrs = osp_dev2node(osp);
        } else {
                ii->ii_fid = *lu_object_fid(&it->ooi_obj->do_lu);
                ii->ii_flags = II_FL_NOHASH | II_FL_NOKEY | II_FL_VARKEY |
                               II_FL_VARREC;
+               ii->ii_attrs = it->ooi_attr;
        }
        ii->ii_magic = IDX_INFO_MAGIC;
        ii->ii_count = npages * LU_PAGE_COUNT;
        ii->ii_hash_start = it->ooi_next;
-       ii->ii_attrs = osp_dev2node(osp);
 
        ptlrpc_at_set_req_timeout(req);
 
@@ -1384,6 +1787,24 @@ out:
        return rc;
 }
 
+/**
+ * Move the iteration cursor to the next lu_page.
+ *
+ * One system page (PAGE_SIZE) may contain multiple lu_page (4KB),
+ * that depends on the LU_PAGE_COUNT. If it is not the last lu_page
+ * in current system page, then move the iteration cursor to the next
+ * lu_page in current system page. Otherwise, if there are more system
+ * pages in the cache, then move the iteration cursor to the next system
+ * page. If all the cached records (pages) have been iterated, then fetch
+ * more records via osp_it_fetch().
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] di       pointer to the iteration structure
+ *
+ * \retval             positive for end of the directory
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 int osp_it_next_page(const struct lu_env *env, struct dt_it *di)
 {
        struct osp_it           *it = (struct osp_it *)di;
@@ -1406,6 +1827,7 @@ again2:
                }
                it->ooi_cur_idxpage = NULL;
                it->ooi_pos_lu_page++;
+
 again1:
                if (it->ooi_pos_lu_page < LU_PAGE_COUNT) {
                        it->ooi_cur_idxpage = (void *)it->ooi_cur_page +
@@ -1468,7 +1890,21 @@ again0:
        RETURN(rc);
 }
 
-int osp_orphan_it_next(const struct lu_env *env, struct dt_it *di)
+/**
+ * Move the iteration cursor to the next record.
+ *
+ * If there are more records in the lu_page, then move the iteration
+ * cursor to the next record directly. Otherwise, move the iteration
+ * cursor to the record in the next lu_page via osp_it_next_page()
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] di       pointer to the iteration structure
+ *
+ * \retval             positive for end of the directory
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
+static int osp_orphan_it_next(const struct lu_env *env, struct dt_it *di)
 {
        struct osp_it           *it = (struct osp_it *)di;
        struct lu_idxpage       *idxpage;
@@ -1509,8 +1945,8 @@ void osp_it_put(const struct lu_env *env, struct dt_it *di)
 {
 }
 
-struct dt_key *osp_orphan_it_key(const struct lu_env *env,
-                                const struct dt_it *di)
+static struct dt_key *osp_orphan_it_key(const struct lu_env *env,
+                                       const struct dt_it *di)
 {
        struct osp_it   *it  = (struct osp_it *)di;
        struct lu_orphan_ent    *ent = (struct lu_orphan_ent *)it->ooi_ent;
@@ -1521,13 +1957,14 @@ struct dt_key *osp_orphan_it_key(const struct lu_env *env,
        return NULL;
 }
 
-int osp_orphan_it_key_size(const struct lu_env *env, const struct dt_it *di)
+static int osp_orphan_it_key_size(const struct lu_env *env,
+                                 const struct dt_it *di)
 {
        return sizeof(struct lu_fid);
 }
 
-int osp_orphan_it_rec(const struct lu_env *env, const struct dt_it *di,
-                     struct dt_rec *rec, __u32 attr)
+static int osp_orphan_it_rec(const struct lu_env *env, const struct dt_it *di,
+                            struct dt_rec *rec, __u32 attr)
 {
        struct osp_it   *it  = (struct osp_it *)di;
        struct lu_orphan_ent    *ent = (struct lu_orphan_ent *)it->ooi_ent;
@@ -1548,10 +1985,16 @@ __u64 osp_it_store(const struct lu_env *env, const struct dt_it *di)
 }
 
 /**
- * \retval      +1: locate to the exactly position
- * \retval       0: cannot locate to the exactly position,
- *                  call next() to move to a valid position.
- * \retval     -ve: on error
+ * Locate the iteration cursor to the specified position (cookie).
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] di       pointer to the iteration structure
+ * \param[in] hash     the specified position
+ *
+ * \retval             positive number for locating to the exactly position
+ *                     or the next
+ * \retval             0 for arriving at the end of the iteration
+ * \retval             negative error number on failure
  */
 int osp_orphan_it_load(const struct lu_env *env, const struct dt_it *di,
                       __u64 hash)
@@ -1597,6 +2040,21 @@ static const struct dt_index_operations osp_orphan_index_ops = {
        }
 };
 
+/**
+ * Implement OSP layer dt_object_operations::do_index_try() interface.
+ *
+ * Negotiate the index type.
+ *
+ * If the target index is an IDIF object, then use osp_orphan_index_ops.
+ * Otherwise, assign osp_md_index_ops to the dt_object::do_index_ops.
+ * (\see lustre/include/lustre_fid.h for IDIF.)
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] dt       pointer to the OSP layer dt_object
+ * \param[in] feat     unused
+ *
+ * \retval             0 for success
+ */
 static int osp_index_try(const struct lu_env *env,
                         struct dt_object *dt,
                         const struct dt_index_features *feat)
@@ -1610,7 +2068,7 @@ static int osp_index_try(const struct lu_env *env,
        return 0;
 }
 
-struct dt_object_operations osp_obj_ops = {
+static struct dt_object_operations osp_obj_ops = {
        .do_declare_attr_get    = osp_declare_attr_get,
        .do_attr_get            = osp_attr_get,
        .do_declare_attr_set    = osp_declare_attr_set,
@@ -1626,6 +2084,21 @@ struct dt_object_operations osp_obj_ops = {
        .do_index_try           = osp_index_try,
 };
 
+/**
+ * Implement OSP layer lu_object_operations::loo_object_init() interface.
+ *
+ * Initialize the object.
+ *
+ * If it is a remote MDT object, then call do_attr_get() to fetch
+ * the attribute from the peer.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] o                pointer to the OSP layer lu_object
+ * \param[in] conf     unused
+ *
+ * \retval             0 for success
+ * \retval             negative error number on failure
+ */
 static int osp_object_init(const struct lu_env *env, struct lu_object *o,
                           const struct lu_object_conf *conf)
 {
@@ -1643,8 +2116,7 @@ static int osp_object_init(const struct lu_env *env, struct lu_object *o,
 
                po->opo_obj.do_ops = &osp_md_obj_ops;
                po->opo_obj.do_body_ops = &osp_md_body_ops;
-               rc = po->opo_obj.do_ops->do_attr_get(env, lu2dt_obj(o),
-                                                    la, NULL);
+               rc = po->opo_obj.do_ops->do_attr_get(env, lu2dt_obj(o), la);
                if (rc == 0)
                        o->lo_header->loh_attr |=
                                LOHA_EXISTS | (la->la_mode & S_IFMT);
@@ -1657,6 +2129,17 @@ static int osp_object_init(const struct lu_env *env, struct lu_object *o,
        RETURN(rc);
 }
 
+/**
+ * Implement OSP layer lu_object_operations::loo_object_free() interface.
+ *
+ * Finalize the object.
+ *
+ * If the OSP object has attributes cache, then destroy the cache.
+ * Free the object finally.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] o                pointer to the OSP layer lu_object
+ */
 static void osp_object_free(const struct lu_env *env, struct lu_object *o)
 {
        struct osp_object       *obj = lu2osp_obj(o);
@@ -1685,6 +2168,17 @@ static void osp_object_free(const struct lu_env *env, struct lu_object *o)
        OBD_SLAB_FREE_PTR(obj, osp_object_kmem);
 }
 
+/**
+ * Implement OSP layer lu_object_operations::loo_object_release() interface.
+ *
+ * Cleanup (not free) the object.
+ *
+ * If it is a reserved object but failed to be created, or it is an OST
+ * object, then mark the object as non-cached.
+ *
+ * \param[in] env      pointer to the thread context
+ * \param[in] o                pointer to the OSP layer lu_object
+ */
 static void osp_object_release(const struct lu_env *env, struct lu_object *o)
 {
        struct osp_object       *po = lu2osp_obj(o);