Whamcloud - gitweb
LU-7728 osp: soft lockup in osp_precreate_reserve()
[fs/lustre-release.git] / lustre / osp / osp_precreate.c
index 6eb22c7..fe63a55 100644 (file)
@@ -27,7 +27,7 @@
  * 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) 2012, 2014, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 
 #define DEBUG_SUBSYSTEM S_MDS
 
+#include <linux/kthread.h>
+
+#include <lustre_obdo.h>
+
 #include "osp_internal.h"
 
 /*
  */
 
 /*
- * statfs
+ **
+ * Check whether statfs data is expired
+ *
+ * OSP device caches statfs data for the target, the function checks
+ * whether the data is expired or not.
+ *
+ * \param[in] d                OSP device
+ *
+ * \retval             0 - not expired, 1 - expired
  */
 static inline int osp_statfs_need_update(struct osp_device *d)
 {
@@ -90,6 +102,22 @@ static void osp_statfs_timer_cb(unsigned long _d)
                wake_up(&d->opd_pre_waitq);
 }
 
+/**
+ * RPC interpret callback for OST_STATFS RPC
+ *
+ * An interpretation callback called by ptlrpc for OST_STATFS RPC when it is
+ * replied by the target. It's used to maintain statfs cache for the target.
+ * The function fills data from the reply if successful and schedules another
+ * update.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] req      RPC replied
+ * \param[in] aa       callback data
+ * \param[in] rc       RPC result
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
+ */
 static int osp_statfs_interpret(const struct lu_env *env,
                                struct ptlrpc_request *req,
                                union ptlrpc_async_args *aa, int rc)
@@ -134,6 +162,16 @@ out:
        RETURN(rc);
 }
 
+/**
+ * Send OST_STATFS RPC
+ *
+ * Sends OST_STATFS RPC to refresh cached statfs data for the target.
+ * Also disables scheduled updates as times OSP may need to refresh
+ * statfs data before expiration. The function doesn't block, instead
+ * an interpretation callback osp_statfs_interpret() is used.
+ *
+ * \param[in] d                OSP device
+ */
 static int osp_statfs_update(struct osp_device *d)
 {
        struct ptlrpc_request   *req;
@@ -172,16 +210,23 @@ static int osp_statfs_update(struct osp_device *d)
        d->opd_statfs_fresh_till = cfs_time_shift(obd_timeout * 1000);
        d->opd_statfs_update_in_progress = 1;
 
-       ptlrpcd_add_req(req, PDL_POLICY_ROUND, -1);
+       ptlrpcd_add_req(req);
 
        RETURN(0);
 }
 
-/*
- * XXX: there might be a case where removed object(s) do not add free
- * space (empty object). if the number of such deletions is high, then
- * we can start to update statfs too often - a rpc storm
- * TODO: some throttling is needed
+/**
+ * Schedule an immediate update for statfs data
+ *
+ * If cached statfs data claim no free space, but OSP has got a request to
+ * destroy an object (so release some space probably), then we may need to
+ * refresh cached statfs data sooner than planned. The function checks there
+ * is no statfs update going and schedules immediate update if so.
+ * XXX: there might be a case where removed object(s) do not add free space (empty
+ * object). If the number of such deletions is high, then we can start to update
+ * statfs too often causing a RPC storm. some throttling is needed...
+ *
+ * \param[in] d                OSP device where statfs data needs to be refreshed
  */
 void osp_statfs_need_now(struct osp_device *d)
 {
@@ -197,30 +242,37 @@ void osp_statfs_need_now(struct osp_device *d)
        }
 }
 
+/**
+ * Return number of precreated objects
+ *
+ * A simple helper to calculate the number of precreated objects on the device.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] osp      OSP device
+ *
+ * \retval             the number of the precreated objects
+ */
 static inline int osp_objs_precreated(const struct lu_env *env,
                                      struct osp_device *osp)
 {
-       struct lu_fid *fid1 = &osp->opd_pre_last_created_fid;
-       struct lu_fid *fid2 = &osp->opd_pre_used_fid;
-
-       LASSERTF(fid_seq(fid1) == fid_seq(fid2),
-                "Created fid"DFID" Next fid "DFID"\n", PFID(fid1), PFID(fid2));
-
-       if (fid_is_idif(fid1)) {
-               struct ost_id *oi1 = &osp_env_info(env)->osi_oi;
-               struct ost_id *oi2 = &osp_env_info(env)->osi_oi2;
-
-               LASSERT(fid_is_idif(fid1) && fid_is_idif(fid2));
-               fid_to_ostid(fid1, oi1);
-               fid_to_ostid(fid2, oi2);
-               LASSERT(ostid_id(oi1) >= ostid_id(oi2));
-
-               return ostid_id(oi1) - ostid_id(oi2);
-       }
-
-       return fid_oid(fid1) - fid_oid(fid2);
+       return osp_fid_diff(&osp->opd_pre_last_created_fid,
+                           &osp->opd_pre_used_fid);
 }
 
+/**
+ * Check pool of precreated objects is nearly empty
+ *
+ * We should not wait till the pool of the precreated objects is exhausted,
+ * because then there will be a long period of OSP being unavailable for the
+ * new creations due to lenghty precreate RPC. Instead we ask for another
+ * precreation ahead and hopefully have it ready before the current pool is
+ * empty. Notice this function relies on an external locking.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ *
+ * \retval             0 - current pool is good enough, 1 - time to precreate
+ */
 static inline int osp_precreate_near_empty_nolock(const struct lu_env *env,
                                                  struct osp_device *d)
 {
@@ -228,10 +280,21 @@ static inline int osp_precreate_near_empty_nolock(const struct lu_env *env,
 
        /* don't consider new precreation till OST is healty and
         * has free space */
-       return ((window - d->opd_pre_reserved < d->opd_pre_grow_count / 2) &&
+       return ((window - d->opd_pre_reserved < d->opd_pre_create_count / 2) &&
                (d->opd_pre_status == 0));
 }
 
+/**
+ * Check pool of precreated objects
+ *
+ * This is protected version of osp_precreate_near_empty_nolock(), check that
+ * for the details.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ *
+ * \retval             0 - current pool is good enough, 1 - time to precreate
+ */
 static inline int osp_precreate_near_empty(const struct lu_env *env,
                                           struct osp_device *d)
 {
@@ -244,6 +307,18 @@ static inline int osp_precreate_near_empty(const struct lu_env *env,
        return rc;
 }
 
+/**
+ * Check given sequence is empty
+ *
+ * Returns a binary result whether the given sequence has some IDs left
+ * or not. Find the details in osp_fid_end_seq(). This is a lock protected
+ * version of that function.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] osp      OSP device
+ *
+ * \retval             0 - current sequence has no IDs, 1 - otherwise
+ */
 static inline int osp_create_end_seq(const struct lu_env *env,
                                     struct osp_device *osp)
 {
@@ -257,7 +332,19 @@ static inline int osp_create_end_seq(const struct lu_env *env,
 }
 
 /**
- * Write fid into last_oid/last_seq file.
+ * Write FID into into last_oid/last_seq file
+ *
+ * The function stores the sequence and the in-sequence id into two dedicated
+ * files. The sync argument can be used to request synchronous commit, so the
+ * function won't return until the updates are committed.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] osp      OSP device
+ * \param[in] fid      fid where sequence/id is taken
+ * \param[in] sync     update mode: 0 - asynchronously, 1 - synchronously
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
  **/
 int osp_write_last_oid_seq_files(struct lu_env *env, struct osp_device *osp,
                                 struct lu_fid *fid, int sync)
@@ -271,16 +358,15 @@ int osp_write_last_oid_seq_files(struct lu_env *env, struct osp_device *osp,
        int                   rc;
        ENTRY;
 
-       /* Note: through f_oid is only 32bits, it will also write
-        * 64 bits for oid to keep compatiblity with the previous
-        * version. */
+       /* Note: through f_oid is only 32 bits, it will also write 64 bits
+        * for oid to keep compatibility with the previous version. */
        lb_oid->lb_buf = &fid->f_oid;
-       lb_oid->lb_len = sizeof(obd_id);
-       oid_off = sizeof(obd_id) * osp->opd_index;
+       lb_oid->lb_len = sizeof(u64);
+       oid_off = sizeof(u64) * osp->opd_index;
 
        lb_oseq->lb_buf = &fid->f_seq;
-       lb_oseq->lb_len = sizeof(obd_id);
-       oseq_off = sizeof(obd_id) * osp->opd_index;
+       lb_oseq->lb_len = sizeof(u64);
+       oseq_off = sizeof(u64) * osp->opd_index;
 
        th = dt_trans_create(env, osp->opd_storage);
        if (IS_ERR(th))
@@ -320,7 +406,27 @@ out:
        RETURN(rc);
 }
 
-int osp_precreate_rollover_new_seq(struct lu_env *env, struct osp_device *osp)
+/**
+ * Switch to another sequence
+ *
+ * When a current sequence has no available IDs left, OSP has to switch to
+ * another new sequence. OSP requests it using the regular FLDB protocol
+ * and stores synchronously before that is used in precreated. This is needed
+ * to basically have the sequences referenced (not orphaned), otherwise it's
+ * possible that OST has some objects precreated and the clients have data
+ * written to it, but after MDT failover nobody refers those objects and OSP
+ * has no idea that the sequence need cleanup to be done.
+ * While this is very expensive operation, it's supposed to happen very very
+ * infrequently because sequence has 2^32 or 2^48 objects (depending on type)
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] osp      OSP device
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
+ */
+static int osp_precreate_rollover_new_seq(struct lu_env *env,
+                                         struct osp_device *osp)
 {
        struct lu_fid   *fid = &osp_env_info(env)->osi_fid;
        struct lu_fid   *last_fid = &osp->opd_last_used_fid;
@@ -362,11 +468,23 @@ int osp_precreate_rollover_new_seq(struct lu_env *env, struct osp_device *osp)
 }
 
 /**
- * alloc fids for precreation.
- * rc = 0 Success, @grow is the count of real allocation.
- * rc = 1 Current seq is used up.
- * rc < 0 Other error.
- **/
+ * Find IDs available in current sequence
+ *
+ * The function calculates the highest possible ID and the number of IDs
+ * available in the current sequence OSP is using. The number is limited
+ * artifically by the caller (grow param) and the number of IDs available
+ * in the sequence by nature. The function doesn't require an external
+ * locking.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] osp      OSP device
+ * \param[in] fid      FID the caller wants to start with
+ * \param[in] grow     how many the caller wants
+ * \param[out] fid     the highest calculated FID
+ * \param[out] grow    the number of available IDs calculated
+ *
+ * \retval             0 on success, 1 - the sequence is empty
+ */
 static int osp_precreate_fids(const struct lu_env *env, struct osp_device *osp,
                              struct lu_fid *fid, int *grow)
 {
@@ -407,6 +525,21 @@ static int osp_precreate_fids(const struct lu_env *env, struct osp_device *osp,
        return *grow > 0 ? 0 : 1;
 }
 
+/**
+ * Prepare and send precreate RPC
+ *
+ * The function finds how many objects should be precreated.  Then allocates,
+ * prepares and schedules precreate RPC synchronously. Upon reply the function
+ * wake ups the threads waiting for the new objects on this target. If the
+ * target wasn't able to create all the objects requested, then the next
+ * precreate will be asking less objects (i.e. slow precreate down).
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
+ **/
 static int osp_precreate_send(const struct lu_env *env, struct osp_device *d)
 {
        struct osp_thread_info  *oti = osp_env_info(env);
@@ -445,9 +578,9 @@ static int osp_precreate_send(const struct lu_env *env, struct osp_device *d)
        }
 
        spin_lock(&d->opd_pre_lock);
-       if (d->opd_pre_grow_count > d->opd_pre_max_grow_count / 2)
-               d->opd_pre_grow_count = d->opd_pre_max_grow_count / 2;
-       grow = d->opd_pre_grow_count;
+       if (d->opd_pre_create_count > d->opd_pre_max_create_count / 2)
+               d->opd_pre_create_count = d->opd_pre_max_create_count / 2;
+       grow = d->opd_pre_create_count;
        spin_unlock(&d->opd_pre_lock);
 
        body = req_capsule_client_get(&req->rq_pill, &RMF_OST_BODY);
@@ -490,25 +623,31 @@ static int osp_precreate_send(const struct lu_env *env, struct osp_device *d)
                GOTO(out_req, rc = -EPROTO);
 
        ostid_to_fid(fid, &body->oa.o_oi, d->opd_index);
-       LASSERTF(lu_fid_diff(fid, &d->opd_pre_used_fid) > 0,
-                "reply fid "DFID" pre used fid "DFID"\n", PFID(fid),
-                PFID(&d->opd_pre_used_fid));
+       if (osp_fid_diff(fid, &d->opd_pre_used_fid) <= 0) {
+               CERROR("%s: precreate fid "DFID" < local used fid "DFID
+                      ": rc = %d\n", d->opd_obd->obd_name,
+                      PFID(fid), PFID(&d->opd_pre_used_fid), -ESTALE);
+               GOTO(out_req, rc = -ESTALE);
+       }
 
-       diff = lu_fid_diff(fid, &d->opd_pre_last_created_fid);
+       diff = osp_fid_diff(fid, &d->opd_pre_last_created_fid);
 
        spin_lock(&d->opd_pre_lock);
        if (diff < grow) {
                /* the OST has not managed to create all the
                 * objects we asked for */
-               d->opd_pre_grow_count = max(diff, OST_MIN_PRECREATE);
-               d->opd_pre_grow_slow = 1;
+               d->opd_pre_create_count = max(diff, OST_MIN_PRECREATE);
+               d->opd_pre_create_slow = 1;
        } else {
                /* the OST is able to keep up with the work,
-                * we could consider increasing grow_count
+                * we could consider increasing create_count
                 * next time if needed */
-               d->opd_pre_grow_slow = 0;
+               d->opd_pre_create_slow = 0;
        }
 
+       body = req_capsule_client_get(&req->rq_pill, &RMF_OST_BODY);
+       fid_to_ostid(fid, &body->oa.o_oi);
+
        d->opd_pre_last_created_fid = *fid;
        spin_unlock(&d->opd_pre_lock);
 
@@ -524,6 +663,20 @@ out_req:
        RETURN(rc);
 }
 
+/**
+ * Get last precreated object from target (OST)
+ *
+ * Sends synchronous RPC to the target (OST) to learn the last precreated
+ * object. This later is used to remove all unused objects (cleanup orphan
+ * procedure). Also, the next object after one we got will be used as a
+ * starting point for the new precreates.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
+ **/
 static int osp_get_lastfid_from_ost(const struct lu_env *env,
                                    struct osp_device *d)
 {
@@ -596,8 +749,21 @@ out:
 }
 
 /**
- * asks OST to clean precreate orphans
- * and gets next id for new objects
+ * Cleanup orphans on OST
+ *
+ * This function is called in a contex of a dedicated thread handling
+ * all the precreation suff. The function waits till local recovery
+ * is complete, then identify all the unreferenced objects (orphans)
+ * using the highest ID referenced by a local and the highest object
+ * precreated by the target. The found range is a subject to removal
+ * using specially flagged RPC. During this process OSP is marked
+ * unavailable for new objects.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
  */
 static int osp_precreate_cleanup_orphans(struct lu_env *env,
                                         struct osp_device *d)
@@ -696,12 +862,12 @@ static int osp_precreate_cleanup_orphans(struct lu_env *env,
        ostid_to_fid(last_fid, &body->oa.o_oi, d->opd_index);
 
        spin_lock(&d->opd_pre_lock);
-       diff = lu_fid_diff(&d->opd_last_used_fid, last_fid);
+       diff = osp_fid_diff(&d->opd_last_used_fid, last_fid);
        if (diff > 0) {
-               d->opd_pre_grow_count = OST_MIN_PRECREATE + diff;
+               d->opd_pre_create_count = OST_MIN_PRECREATE + diff;
                d->opd_pre_last_created_fid = d->opd_last_used_fid;
        } else {
-               d->opd_pre_grow_count = OST_MIN_PRECREATE;
+               d->opd_pre_create_count = OST_MIN_PRECREATE;
                d->opd_pre_last_created_fid = *last_fid;
        }
        /*
@@ -711,7 +877,7 @@ static int osp_precreate_cleanup_orphans(struct lu_env *env,
        LASSERT(fid_oid(&d->opd_pre_last_created_fid) <=
                LUSTRE_DATA_SEQ_MAX_WIDTH);
        d->opd_pre_used_fid = d->opd_pre_last_created_fid;
-       d->opd_pre_grow_slow = 0;
+       d->opd_pre_create_slow = 0;
        spin_unlock(&d->opd_pre_lock);
 
        CDEBUG(D_HA, "%s: Got last_id "DFID" from OST, last_created "DFID
@@ -748,13 +914,36 @@ out:
        RETURN(rc);
 }
 
-/*
+/**
+ * Update precreate status using statfs data
+ *
+ * The function decides whether this OSP should be used for new objects.
+ * IOW, whether this OST is used up or has some free space. Cached statfs
+ * data is used to make this decision. If the latest result of statfs
+ * request (rc argument) is not success, then just mark OSP unavailable
+ * right away.
+
+ * Add a bit of hysteresis so this flag isn't continually flapping,
+ * and ensure that new files don't get extremely fragmented due to
+ * only a small amount of available space in the filesystem.
+ * We want to set the NOSPC flag when there is less than ~0.1% free
+ * and clear it when there is at least ~0.2% free space, so:
+ *                   avail < ~0.1% max          max = avail + used
+ *            1025 * avail < avail + used       used = blocks - free
+ *            1024 * avail < used
+ *            1024 * avail < blocks - free
+ *                   avail < ((blocks - free) >> 10)
+ *
+ * On very large disk, say 16TB 0.1% will be 16 GB. We don't want to
+ * lose that amount of space so in those cases we report no space left
+ * if their is less than 1 GB left.
  * the function updates current precreation status used: functional or not
  *
- * rc is a last code from the transport, rc == 0 meaning transport works
- * well and users of lod can use objects from this OSP
+ * \param[in] d                OSP device
+ * \param[in] rc       new precreate status for device \a d
  *
- * the status depends on current usage of OST
+ * \retval 0           on success
+ * \retval negative    negated errno on error
  */
 void osp_pre_update_status(struct osp_device *d, int rc)
 {
@@ -766,20 +955,6 @@ void osp_pre_update_status(struct osp_device *d, int rc)
        if (rc)
                goto out;
 
-       /* Add a bit of hysteresis so this flag isn't continually flapping,
-        * and ensure that new files don't get extremely fragmented due to
-        * only a small amount of available space in the filesystem.
-        * We want to set the NOSPC flag when there is less than ~0.1% free
-        * and clear it when there is at least ~0.2% free space, so:
-        *                   avail < ~0.1% max          max = avail + used
-        *            1025 * avail < avail + used       used = blocks - free
-        *            1024 * avail < used
-        *            1024 * avail < blocks - free
-        *                   avail < ((blocks - free) >> 10)
-        *
-        * On very large disk, say 16TB 0.1% will be 16 GB. We don't want to
-        * lose that amount of space so in those cases we report no space left
-        * if their is less than 1 GB left.                             */
        if (likely(msfs->os_type)) {
                used = min_t(__u64, (msfs->os_blocks - msfs->os_bfree) >> 10,
                                    1 << 30);
@@ -793,13 +968,13 @@ void osp_pre_update_status(struct osp_device *d, int rc)
                                       msfs->os_bfree, used, msfs->os_bavail,
                                       d->opd_pre_status, rc);
                        CDEBUG(D_INFO,
-                              "non-commited changes: %lu, in progress: %u\n",
+                              "non-committed changes: %lu, in progress: %u\n",
                               d->opd_syn_changes, d->opd_syn_rpc_in_progress);
                } else if (old == -ENOSPC) {
                        d->opd_pre_status = 0;
                        spin_lock(&d->opd_pre_lock);
-                       d->opd_pre_grow_slow = 0;
-                       d->opd_pre_grow_count = OST_MIN_PRECREATE;
+                       d->opd_pre_create_slow = 0;
+                       d->opd_pre_create_count = OST_MIN_PRECREATE;
                        spin_unlock(&d->opd_pre_lock);
                        wake_up(&d->opd_pre_waitq);
                        CDEBUG(D_INFO, "%s: no space: "LPU64" blocks, "LPU64
@@ -814,6 +989,22 @@ out:
        wake_up(&d->opd_pre_user_waitq);
 }
 
+/**
+ * Initialize FID for precreation
+ *
+ * For a just created new target, a new sequence should be taken.
+ * The function checks there is no IDIF in use (if the target was
+ * added with the older version of Lustre), then requests a new
+ * sequence from FLDB using the regular protocol. Then this new
+ * sequence is stored on a persisten storage synchronously to prevent
+ * possible object leakage (for the detail see the description for
+ * osp_precreate_rollover_new_seq()).
+ *
+ * \param[in] osp      OSP device
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
+ */
 int osp_init_pre_fid(struct osp_device *osp)
 {
        struct lu_env           env;
@@ -870,6 +1061,24 @@ out:
        RETURN(rc);
 }
 
+/**
+ * The core of precreate functionality
+ *
+ * The function implements the main precreation loop. Basically it
+ * involves connecting to the target, precerate FID initialization,
+ * identifying and removing orphans, then serving precreation. As
+ * part of the latter, the thread is responsible for statfs data
+ * updates. The precreation is mostly driven by another threads
+ * asking for new OST objects - those askers wake the thread when
+ * the number of precreated objects reach low watermark.
+ * After a disconnect, the sequence above repeats. This is keep going
+ * until the thread is requested to stop.
+ *
+ * \param[in] _arg     private data the thread (OSP device to handle)
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
+ */
 static int osp_precreate_thread(void *_arg)
 {
        struct osp_device       *d = _arg;
@@ -996,6 +1205,20 @@ static int osp_precreate_thread(void *_arg)
        RETURN(0);
 }
 
+/**
+ * Check when to stop to wait for precreate objects.
+ *
+ * The caller wanting a new OST object can't wait undefinitely. The
+ * function checks for few conditions including available new OST
+ * objects, disconnected OST, lack of space with no pending destroys,
+ * etc. IOW, it checks whether the current OSP state is good to keep
+ * waiting or it's better to give up.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ *
+ * \retval             0 - keep waiting, 1 - no luck
+ */
 static int osp_precreate_ready_condition(const struct lu_env *env,
                                         struct osp_device *d)
 {
@@ -1016,6 +1239,7 @@ static int osp_precreate_ready_condition(const struct lu_env *env,
        if (d->opd_pre_status != 0 &&
            d->opd_pre_status != -EAGAIN &&
            d->opd_pre_status != -ENODEV &&
+           d->opd_pre_status != -ENOTCONN &&
            d->opd_pre_status != -ENOSPC) {
                /* DEBUG LU-3230 */
                if (d->opd_pre_status != -EIO)
@@ -1031,23 +1255,40 @@ static int osp_precreate_timeout_condition(void *data)
 {
        struct osp_device *d = data;
 
-       LCONSOLE_WARN("%s: slow creates, last="DFID", next="DFID", "
-                     "reserved="LPU64", syn_changes=%lu, "
-                     "syn_rpc_in_progress=%d, status=%d\n",
-                     d->opd_obd->obd_name, PFID(&d->opd_pre_last_created_fid),
-                     PFID(&d->opd_pre_used_fid), d->opd_pre_reserved,
-                     d->opd_syn_changes, d->opd_syn_rpc_in_progress,
-                     d->opd_pre_status);
+       CDEBUG(D_HA, "%s: slow creates, last="DFID", next="DFID", "
+             "reserved="LPU64", syn_changes=%lu, "
+             "syn_rpc_in_progress=%d, status=%d\n",
+             d->opd_obd->obd_name, PFID(&d->opd_pre_last_created_fid),
+             PFID(&d->opd_pre_used_fid), d->opd_pre_reserved,
+             d->opd_syn_changes, d->opd_syn_rpc_in_progress,
+             d->opd_pre_status);
 
        return 1;
 }
 
-/*
- * called to reserve object in the pool
- * return codes:
- *  ENOSPC - no space on corresponded OST
- *  EAGAIN - precreation is in progress, try later
- *  EIO    - no access to OST
+/**
+ * Reserve object in precreate pool
+ *
+ * When the caller wants to create a new object on this target (target
+ * represented by the given OSP), it should declare this intention using
+ * a regular ->dt_declare_create() OSD API method. Then OSP will be trying
+ * to reserve an object in the existing precreated pool or wait up to
+ * obd_timeout for the available object to appear in the pool (a dedicated
+ * thread will be doing real precreation in background). The object can be
+ * consumed later with osp_precreate_get_fid() or be released with call to
+ * lu_object_put(). Notice the function doesn't reserve a specific ID, just
+ * some ID. The actual ID assignment happen in osp_precreate_get_fid().
+ * If the space on the target is short and there is a pending object destroy,
+ * then the function forces local commit to speedup space release (see
+ * osp_sync.c for the details).
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ *
+ * \retval             0 on success
+ * \retval             -ENOSPC when no space on OST
+ * \retval             -EAGAIN try later, slow precreation in progress
+ * \retval             -EIO when no access to OST
  */
 int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d)
 {
@@ -1075,12 +1316,12 @@ int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d)
                 * increase number of precreations
                 */
                precreated = osp_objs_precreated(env, d);
-               if (d->opd_pre_grow_count < d->opd_pre_max_grow_count &&
-                   d->opd_pre_grow_slow == 0 &&
-                   precreated <= (d->opd_pre_grow_count / 4 + 1)) {
+               if (d->opd_pre_create_count < d->opd_pre_max_create_count &&
+                   d->opd_pre_create_slow == 0 &&
+                   precreated <= (d->opd_pre_create_count / 4 + 1)) {
                        spin_lock(&d->opd_pre_lock);
-                       d->opd_pre_grow_slow = 1;
-                       d->opd_pre_grow_count *= 2;
+                       d->opd_pre_create_slow = 1;
+                       d->opd_pre_create_count *= 2;
                        spin_unlock(&d->opd_pre_lock);
                }
 
@@ -1140,8 +1381,27 @@ int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d)
        RETURN(rc);
 }
 
-/*
- * this function relies on reservation made before
+/**
+ * Get a FID from precreation pool
+ *
+ * The function is a companion for osp_precreate_reserve() - it assigns
+ * a specific FID from the precreate. The function should be called only
+ * if the call to osp_precreate_reserve() was successful. The function
+ * updates a local storage to remember the highest object ID referenced
+ * by the node in the given sequence.
+ *
+ * A very importan details: this is supposed to be called once the
+ * transaction is started, so on-disk update will be atomic with the
+ * data (like LOVEA) refering this object. Then the object won't be leaked:
+ * either it's referenced by the committed transaction or it's a subject
+ * to the orphan cleanup procedure.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] d                OSP device
+ * \param[out] fid     generated FID
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
  */
 int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
                          struct lu_fid *fid)
@@ -1149,7 +1409,7 @@ int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
        /* grab next id from the pool */
        spin_lock(&d->opd_pre_lock);
 
-       LASSERTF(lu_fid_diff(&d->opd_pre_used_fid,
+       LASSERTF(osp_fid_diff(&d->opd_pre_used_fid,
                             &d->opd_pre_last_created_fid) < 0,
                 "next fid "DFID" last created fid "DFID"\n",
                 PFID(&d->opd_pre_used_fid),
@@ -1177,7 +1437,20 @@ int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
 }
 
 /*
+ * Set size regular attribute on an object
  *
+ * When a striping is created late, it's possible that size is already
+ * initialized on the file. Then the new striping should inherit size
+ * from the file. The function sets size on the object using the regular
+ * protocol (OST_PUNCH).
+ * XXX: should be re-implemented using OUT ?
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] dt       object
+ * \param[in] size     size to set.
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
  */
 int osp_object_truncate(const struct lu_env *env, struct dt_object *dt,
                        __u64 size)
@@ -1210,6 +1483,13 @@ int osp_object_truncate(const struct lu_env *env, struct dt_object *dt,
         * XXX: decide how do we do here with resend
         * if we don't resend, then client may see wrong file size
         * if we do resend, then MDS thread can get stuck for quite long
+        * and if we don't resend, then client will also get -EWOULDBLOCK !!
+        * (see LU-7975 and sanity/test_27F use cases)
+        * but let's decide not to resend/delay this truncate request to OST
+        * and allow Client to decide to resend, in a less agressive way from
+        * after_reply(), by returning -EINPROGRESS instead of
+        * -EAGAIN/-EWOULDBLOCK upon return from ptlrpc_queue_wait() at the
+        * end of this routine
         */
        req->rq_no_resend = req->rq_no_delay = 1;
 
@@ -1237,8 +1517,23 @@ int osp_object_truncate(const struct lu_env *env, struct dt_object *dt,
        ptlrpc_request_set_replen(req);
 
        rc = ptlrpc_queue_wait(req);
-       if (rc)
-               CERROR("can't punch object: %d\n", rc);
+       if (rc) {
+               /* -EWOULDBLOCK/-EAGAIN means OST is unreachable at the moment
+                * since we have decided not to resend/delay, but this could
+                * lead to wrong size to be seen at Client side and even process
+                * trying to open to exit/fail if not itself handling -EAGAIN.
+                * So it should be better to return -EINPROGRESS instead and
+                * leave the decision to resend at Client side in after_reply()
+                */
+               if (rc == -EWOULDBLOCK) {
+                       rc = -EINPROGRESS;
+                       CDEBUG(D_HA, "returning -EINPROGRESS instead of "
+                              "-EWOULDBLOCK/-EAGAIN to allow Client to "
+                              "resend\n");
+               } else {
+                       CERROR("can't punch object: %d\n", rc);
+               }
+       }
 out:
        ptlrpc_req_finished(req);
        if (oa)
@@ -1246,6 +1541,16 @@ out:
        RETURN(rc);
 }
 
+/**
+ * Initialize precreation functionality of OSP
+ *
+ * Prepares all the internal structures and starts the precreate thread
+ *
+ * \param[in] d                OSP device
+ *
+ * \retval 0           on success
+ * \retval negative    negated errno on error
+ */
 int osp_init_precreate(struct osp_device *d)
 {
        struct l_wait_info       lwi = { 0 };
@@ -1265,10 +1570,10 @@ int osp_init_precreate(struct osp_device *d)
        d->opd_pre_last_created_fid.f_oid = 1;
        d->opd_pre_reserved = 0;
        d->opd_got_disconnected = 1;
-       d->opd_pre_grow_slow = 0;
-       d->opd_pre_grow_count = OST_MIN_PRECREATE;
-       d->opd_pre_min_grow_count = OST_MIN_PRECREATE;
-       d->opd_pre_max_grow_count = OST_MAX_PRECREATE;
+       d->opd_pre_create_slow = 0;
+       d->opd_pre_create_count = OST_MIN_PRECREATE;
+       d->opd_pre_min_create_count = OST_MIN_PRECREATE;
+       d->opd_pre_max_create_count = OST_MAX_PRECREATE;
 
        spin_lock_init(&d->opd_pre_lock);
        init_waitqueue_head(&d->opd_pre_waitq);
@@ -1302,6 +1607,15 @@ int osp_init_precreate(struct osp_device *d)
        RETURN(0);
 }
 
+/**
+ * Finish precreate functionality of OSP
+ *
+ *
+ * Asks all the activity (the thread, update timer) to stop, then
+ * wait till that is done.
+ *
+ * \param[in] d                OSP device
+ */
 void osp_precreate_fini(struct osp_device *d)
 {
        struct ptlrpc_thread *thread;