Whamcloud - gitweb
LU-4975 ofd: add comments for ofd_grant.c functions
[fs/lustre-release.git] / lustre / ofd / ofd_grant.c
index 6d85215..ff205f5 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * version 2 along with this program; If not, see
- * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
+ * http://www.gnu.org/licenses/gpl-2.0.html
  *
  * GPL HEADER END
  */
  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2011, 2012, Whamcloud, Inc.
+ * Copyright (c) 2012, 2014, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
  * Lustre is a trademark of Sun Microsystems, Inc.
- *
+ */
+/*
  * lustre/ofd/ofd_grant.c
  *
- * Author: Johann Lombardi <johann@whamcloud..com>
+ * This file provides code related to grant space management on Object Storage
+ * Targets (OSTs). Grant is a mechanism used by client nodes to reserve disk
+ * space on OSTs for the data writeback cache. The Lustre client is thus assured
+ * that enough space will be available when flushing dirty pages asynchronously.
+ * Each client node is granted an initial amount of reserved space at connect
+ * time and gets additional space back from OST in bulk write reply.
+ *
+ * This file handles the core logic for:
+ * - grant allocation strategy
+ * - maintaining per-client as well as global grant space accounting
+ * - processing grant information packed in incoming requests
+ * - allocating server-side grant space for synchronous write RPCs which did not
+ *   consume grant on the client side (OBD_BRW_FROM_GRANT flag not set). If not
+ *   enough space is available, such RPCs fail with ENOSPC
+ *
+ * Author: Johann Lombardi <johann.lombardi@intel.com>
  */
 
 #define DEBUG_SUBSYSTEM S_FILTER
 
 #include "ofd_internal.h"
 
-#define OFD_GRANT_CHUNK (2ULL * PTLRPC_MAX_BRW_SIZE)
-#define OFD_GRANT_SHRINK_LIMIT (16ULL * OFD_GRANT_CHUNK)
+/* At least enough to send a couple of 1MB RPCs, even if not max sized */
+#define OFD_GRANT_CHUNK                        (2ULL * DT_MAX_BRW_SIZE)
+
+/* Clients typically hold 2x their max_rpcs_in_flight of grant space */
+#define OFD_GRANT_SHRINK_LIMIT(exp)    (2ULL * 8 * exp_max_brw_size(exp))
 
 static inline obd_size ofd_grant_from_cli(struct obd_export *exp,
                                          struct ofd_device *ofd, obd_size val)
@@ -67,36 +82,45 @@ static inline obd_size ofd_grant_to_cli(struct obd_export *exp,
 static inline obd_size ofd_grant_chunk(struct obd_export *exp,
                                       struct ofd_device *ofd)
 {
-       if (exp && ofd_obd(ofd)->obd_self_export == exp)
+       if (ofd_obd(ofd)->obd_self_export == exp)
                /* Grant enough space to handle a big precreate request */
-               return OST_MAX_PRECREATE * ofd->ofd_dt_conf.ddp_inodespace;
+               return OST_MAX_PRECREATE * ofd->ofd_dt_conf.ddp_inodespace / 2;
 
-       if (exp && ofd_grant_compat(exp, ofd))
+       if (ofd_grant_compat(exp, ofd))
                /* Try to grant enough space to send a full-size RPC */
-               return PTLRPC_MAX_BRW_SIZE <<
+               return exp_max_brw_size(exp) <<
                       (ofd->ofd_blockbits - COMPAT_BSIZE_SHIFT);
-       return OFD_GRANT_CHUNK;
+
+       /* Try to return enough to send two full RPCs, if needed */
+       return exp_max_brw_size(exp) * 2;
 }
 
 /**
- * Perform extra sanity checks for grant accounting. This is done at connect,
- * disconnect, and statfs RPC time, so it shouldn't be too bad. We can
- * always get rid of it or turn it off when we know accounting is good.
+ * Perform extra sanity checks for grant accounting.
+ *
+ * This function scans the export list, sanity checks per-export grant counters
+ * and verifies accuracy of global grant accounting. If an inconsistency is
+ * found, a CERROR is printed with the function name \func that was passed as
+ * argument. LBUG is only called in case of serious counter corruption (i.e.
+ * value larger than the device size).
+ * Those sanity checks can be pretty expensive and are disabled if the OBD
+ * device has more than 100 connected exports.
  *
- * \param obd - is the device to check
- * \param func - is the function to call if an inconsistency is found
+ * \param[in] obd      OBD device for which grant accounting should be
+ *                     verified
+ * \param[in] func     caller's function name
  */
 void ofd_grant_sanity_check(struct obd_device *obd, const char *func)
 {
-       struct filter_export_data       *fed;
-       struct ofd_device               *ofd = ofd_dev(obd->obd_lu_dev);
-       struct obd_export               *exp;
-       obd_size                         maxsize;
-       obd_size                         tot_dirty = 0;
-       obd_size                         tot_pending = 0;
-       obd_size                         tot_granted = 0;
-       obd_size                         fo_tot_dirty, fo_tot_pending;
-       obd_size                         fo_tot_granted;
+       struct ofd_device       *ofd = ofd_dev(obd->obd_lu_dev);
+       struct obd_export       *exp;
+       obd_size                 maxsize;
+       obd_size                 tot_dirty = 0;
+       obd_size                 tot_pending = 0;
+       obd_size                 tot_granted = 0;
+       obd_size                 fo_tot_granted;
+       obd_size                 fo_tot_pending;
+       obd_size                 fo_tot_dirty;
 
        if (cfs_list_empty(&obd->obd_exports))
                return;
@@ -108,10 +132,11 @@ void ofd_grant_sanity_check(struct obd_device *obd, const char *func)
 
        maxsize = ofd->ofd_osfs.os_blocks << ofd->ofd_blockbits;
 
-       cfs_spin_lock(&obd->obd_dev_lock);
-       cfs_spin_lock(&ofd->ofd_grant_lock);
+       spin_lock(&obd->obd_dev_lock);
+       spin_lock(&ofd->ofd_grant_lock);
        cfs_list_for_each_entry(exp, &obd->obd_exports, exp_obd_chain) {
-               int error = 0;
+               struct filter_export_data       *fed;
+               int                              error = 0;
 
                fed = &exp->exp_filter_data;
 
@@ -128,16 +153,16 @@ void ofd_grant_sanity_check(struct obd_device *obd, const char *func)
                               " > maxsize("LPU64")\n", obd->obd_name,
                               exp->exp_client_uuid.uuid, exp, fed->fed_grant,
                               fed->fed_pending, maxsize);
-                       cfs_spin_unlock(&obd->obd_dev_lock);
-                       cfs_spin_unlock(&ofd->ofd_grant_lock);
+                       spin_unlock(&obd->obd_dev_lock);
+                       spin_unlock(&ofd->ofd_grant_lock);
                        LBUG();
                }
                if (fed->fed_dirty > maxsize) {
                        CERROR("%s: cli %s/%p fed_dirty(%ld) > maxsize("LPU64
                               ")\n", obd->obd_name, exp->exp_client_uuid.uuid,
                               exp, fed->fed_dirty, maxsize);
-                       cfs_spin_unlock(&obd->obd_dev_lock);
-                       cfs_spin_unlock(&ofd->ofd_grant_lock);
+                       spin_unlock(&obd->obd_dev_lock);
+                       spin_unlock(&ofd->ofd_grant_lock);
                        LBUG();
                }
                CDEBUG_LIMIT(error ? D_ERROR : D_CACHE, "%s: cli %s/%p dirty "
@@ -148,7 +173,7 @@ void ofd_grant_sanity_check(struct obd_device *obd, const char *func)
                tot_pending += fed->fed_pending;
                tot_dirty += fed->fed_dirty;
        }
-       cfs_spin_unlock(&obd->obd_dev_lock);
+       spin_unlock(&obd->obd_dev_lock);
        fo_tot_granted = ofd->ofd_tot_granted;
        fo_tot_pending = ofd->ofd_tot_pending;
        fo_tot_dirty = ofd->ofd_tot_dirty;
@@ -171,19 +196,23 @@ void ofd_grant_sanity_check(struct obd_device *obd, const char *func)
        if (tot_dirty > maxsize)
                CERROR("%s: tot_dirty "LPU64" > maxsize "LPU64"\n",
                       func, tot_dirty, maxsize);
-       cfs_spin_unlock(&ofd->ofd_grant_lock);
+       spin_unlock(&ofd->ofd_grant_lock);
 }
 
 /**
- * Get fresh statfs information from the OSD layer if the cache is older than 1s
- * or if force is set. The OSD layer is in charge of estimating data & metadata
- * overhead.
+ * Update cached statfs information from the OSD layer
+ *
+ * Refresh statfs information cached in ofd::ofd_osfs if the cache is older
+ * than 1s or if force is set. The OSD layer is in charge of estimating data &
+ * metadata overhead.
+ * This function can sleep so it should not be called with any spinlock held.
  *
- * \param env - is the lu environment passed by the caller
- * \param exp - export used to print client info in debug messages
- * \param force - is used to force a refresh of statfs information
- * \param from_cache - returns whether the statfs information are
- *                  taken from cache
+ * \param[in] env              LU environment passed by the caller
+ * \param[in] exp              export used to print client info in debug
+ *                             messages
+ * \param[in] force            force a refresh of statfs information
+ * \param[out] from_cache      returns whether the statfs information are
+ *                             taken from cache
  */
 static void ofd_grant_statfs(const struct lu_env *env, struct obd_export *exp,
                             int force, int *from_cache)
@@ -201,7 +230,8 @@ static void ofd_grant_statfs(const struct lu_env *env, struct obd_export *exp,
 
        rc = ofd_statfs_internal(env, ofd, osfs, max_age, from_cache);
        if (unlikely(rc)) {
-               *from_cache = 0;
+               if (from_cache)
+                       *from_cache = 0;
                return;
        }
 
@@ -212,29 +242,35 @@ static void ofd_grant_statfs(const struct lu_env *env, struct obd_export *exp,
 }
 
 /**
- * Figure out how much space is available on the backend filesystem.
+ * Figure out how much space is available on the backend filesystem after
+ * removing grant space already booked by clients.
+ *
  * This is done by accessing cached statfs data previously populated by
  * ofd_grant_statfs(), from which we withdraw the space already granted to
  * clients and the reserved space.
+ * Caller must hold ofd_grant_lock spinlock.
  *
- * \param exp - export which received the write request
+ * \param[in] exp      export associated with the device for which the amount
+ *                     of available space is requested
+ * \retval             amount of non-allocated space, in bytes
  */
 static obd_size ofd_grant_space_left(struct obd_export *exp)
 {
        struct obd_device       *obd = exp->exp_obd;
        struct ofd_device       *ofd = ofd_exp(exp);
        obd_size                 tot_granted;
-       obd_size                 left, avail;
+       obd_size                 left;
+       obd_size                 avail;
        obd_size                 unstable;
 
        ENTRY;
-       LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
+       assert_spin_locked(&ofd->ofd_grant_lock);
 
-       cfs_spin_lock(&ofd->ofd_osfs_lock);
+       spin_lock(&ofd->ofd_osfs_lock);
        /* get available space from cached statfs data */
        left = ofd->ofd_osfs.os_bavail << ofd->ofd_blockbits;
        unstable = ofd->ofd_osfs_unstable; /* those might be accounted twice */
-       cfs_spin_unlock(&ofd->ofd_osfs_lock);
+       spin_unlock(&ofd->ofd_osfs_lock);
 
        tot_granted = ofd->ofd_tot_granted;
 
@@ -244,10 +280,11 @@ static obd_size ofd_grant_space_left(struct obd_export *exp)
                            D_ERROR : D_CACHE;
 
                CDEBUG_LIMIT(mask, "%s: cli %s/%p left "LPU64" < tot_grant "
-                            LPU64" unstable "LPU64" pending "LPU64"\n",
+                            LPU64" unstable "LPU64" pending "LPU64" "
+                            "dirty "LPU64"\n",
                             obd->obd_name, exp->exp_client_uuid.uuid, exp,
                             left, tot_granted, unstable,
-                            ofd->ofd_tot_pending);
+                            ofd->ofd_tot_pending, ofd->ofd_tot_dirty);
                RETURN(0);
        }
 
@@ -275,13 +312,16 @@ static obd_size ofd_grant_space_left(struct obd_export *exp)
 }
 
 /**
+ * Process grant information from obdo structure packed in incoming BRW
+ *
  * Grab the dirty and seen grant announcements from the incoming obdo.
  * We will later calculate the client's new grant and return it.
  * Caller must hold ofd_grant_lock spinlock.
  *
- * \param env - is the lu environment supplying osfs storage
- * \param exp - is the export for which we received the request
- * \paral oa - is the incoming obdo sent by the client
+ * \param[in] env      LU environment supplying osfs storage
+ * \param[in] exp      export for which we received the request
+ * \param[in,out] oa   incoming obdo sent by the client
+ *
  */
 static void ofd_grant_incoming(const struct lu_env *env, struct obd_export *exp,
                               struct obdo *oa)
@@ -289,10 +329,12 @@ static void ofd_grant_incoming(const struct lu_env *env, struct obd_export *exp,
        struct filter_export_data       *fed;
        struct ofd_device               *ofd = ofd_exp(exp);
        struct obd_device               *obd = exp->exp_obd;
-       long                             dirty, dropped, grant_chunk;
+       long                             dirty;
+       long                             dropped;
+       long                             grant_chunk;
        ENTRY;
 
-       LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
+       assert_spin_locked(&ofd->ofd_grant_lock);
 
        if ((oa->o_valid & (OBD_MD_FLBLOCKS|OBD_MD_FLGRANT)) !=
                                        (OBD_MD_FLBLOCKS|OBD_MD_FLGRANT)) {
@@ -345,35 +387,38 @@ static void ofd_grant_incoming(const struct lu_env *env, struct obd_export *exp,
                CERROR("%s: cli %s/%p dirty %ld pend %ld grant %ld\n",
                       obd->obd_name, exp->exp_client_uuid.uuid, exp,
                       fed->fed_dirty, fed->fed_pending, fed->fed_grant);
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                LBUG();
        }
        EXIT;
 }
 
 /**
- * Called when the client is able to release some grants. Proceed with the
- * shrink request when there is less ungranted space remaining
- * than the amount all of the connected clients would consume if they
- * used their full grant.
+ * Grant shrink request handler.
+ *
+ * Client nodes can explicitly release grant space (i.e. process called grant
+ * shrinking). This function proceeds with the shrink request when there is
+ * less ungranted space remaining than the amount all of the connected clients
+ * would consume if they used their full grant.
+ * Caller must hold ofd_grant_lock spinlock.
  *
- * \param exp - is the export for which we received the request
- * \paral oa - is the incoming obdo sent by the client
- * \param left_space - is the remaining free space with space already granted
- *                  taken out
+ * \param[in] exp              export releasing grant space
+ * \param[in,out] oa           incoming obdo sent by the client
+ * \param[in] left_space       remaining free space with space already granted
+ *                             taken out
  */
-static void ofd_grant_shrink(struct obd_export *exp,
-                            struct obdo *oa, obd_size left_space)
+static void ofd_grant_shrink(struct obd_export *exp, struct obdo *oa,
+                            obd_size left_space)
 {
        struct filter_export_data       *fed;
        struct ofd_device               *ofd = ofd_exp(exp);
        struct obd_device               *obd = exp->exp_obd;
        long                             grant_shrink;
 
-       LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
-
+       assert_spin_locked(&ofd->ofd_grant_lock);
+       LASSERT(exp);
        if (left_space >= ofd->ofd_tot_granted_clients *
-                         OFD_GRANT_SHRINK_LIMIT)
+                         OFD_GRANT_SHRINK_LIMIT(exp))
                return;
 
        grant_shrink = ofd_grant_from_cli(exp, ofd, oa->o_grant);
@@ -392,12 +437,27 @@ static void ofd_grant_shrink(struct obd_export *exp,
 
 /**
  * Calculate how much space is required to write a given network buffer
+ *
+ * This function takes block alignment into account to estimate how much on-disk
+ * space will be required to successfully write the whole niobuf.
+ * Estimated space is inflated if the export does not support
+ * OBD_CONNECT_GRANT_PARAM and if the backend filesystem has a block size
+ * larger than the minimal supported page size (i.e. 4KB).
+ *
+ * \param[in] exp      export associated which the write request
+ * \param[in] ofd      ofd device handling the request
+ * \param[in] rnb      network buffer to estimate size of
+ *
+ * \retval             space (in bytes) that will be consumed to write the
+ *                     network buffer
  */
 static inline int ofd_grant_rnb_size(struct obd_export *exp,
                                     struct ofd_device *ofd,
                                     struct niobuf_remote *rnb)
 {
-       obd_size blocksize, bytes, end;
+       obd_size blocksize;
+       obd_size bytes;
+       obd_size end;
 
        if (exp && ofd_grant_compat(exp, ofd))
                blocksize = 1ULL << COMPAT_BSIZE_SHIFT;
@@ -417,24 +477,28 @@ static inline int ofd_grant_rnb_size(struct obd_export *exp,
        return bytes;
 }
 
-
 /**
+ * Validate grant accounting for each incoming remote network buffer.
+ *
  * When clients have dirtied as much space as they've been granted they
- * fall through to sync writes.  These sync writes haven't been expressed
+ * fall through to sync writes. These sync writes haven't been expressed
  * in grants and need to error with ENOSPC when there isn't room in the
- * filesystem for them after grants are taken into account.  However,
+ * filesystem for them after grants are taken into account. However,
  * writeback of the dirty data that was already granted space can write
  * right on through.
+ * The OBD_BRW_GRANTED flag will be set in the rnb_flags of each network
+ * buffer which has been granted enough space to proceed. Buffers without
+ * this flag will fail to be written with -ENOSPC (see ofd_preprw_write().
  * Caller must hold ofd_grant_lock spinlock.
  *
- * \param env - is the lu environment passed by the caller
- * \param exp - is the export identifying the client which sent the RPC
- * \param oa  - is the incoming obdo in which we should return the pack the
- *           additional grant
- * \param rnb - is the list of network buffers
- * \param niocont - is the number of network buffers in the list
- * \param left - is the remaining free space with space already granted
- *            taken out
+ * \param[in] env      LU environment passed by the caller
+ * \param[in] exp      export identifying the client which sent the RPC
+ * \param[in] oa       incoming obdo in which we should return the pack the
+ *                     additional grant
+ * \param[in,out] rnb  the list of network buffers
+ * \param[in] niocont  the number of network buffers in the list
+ * \param[in] left     the remaining free space with space already granted
+ *                     taken out
  */
 static void ofd_grant_check(const struct lu_env *env, struct obd_export *exp,
                            struct obdo *oa, struct niobuf_remote *rnb,
@@ -451,7 +515,7 @@ static void ofd_grant_check(const struct lu_env *env, struct obd_export *exp,
 
        ENTRY;
 
-       LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
+       assert_spin_locked(&ofd->ofd_grant_lock);
 
        if ((oa->o_valid & OBD_MD_FLFLAGS) &&
            (oa->o_flags & OBD_FL_RECOV_RESEND)) {
@@ -565,24 +629,34 @@ static void ofd_grant_check(const struct lu_env *env, struct obd_export *exp,
                CERROR("%s: cli %s/%p dirty %ld pend %ld grant %ld\n",
                       obd->obd_name, exp->exp_client_uuid.uuid, exp,
                       fed->fed_dirty, fed->fed_pending, fed->fed_grant);
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                LBUG();
        }
        EXIT;
 }
 
 /**
+ * Allocate additional grant space to a client
+ *
  * Calculate how much grant space to return to client, based on how much space
  * is currently free and how much of that is already granted.
  * Caller must hold ofd_grant_lock spinlock.
  *
- * \param exp - is the export of the client which sent the request
- * \param curgrant - is the current grant claimed by the client
- * \param want - is how much grant space the client would like to have
- * \param left - is the remaining free space with granted space taken out
+ * \param[in] exp              export of the client which sent the request
+ * \param[in] curgrant         current grant claimed by the client
+ * \param[in] want             how much grant space the client would like to
+ *                             have
+ * \param[in] left             remaining free space with granted space taken
+ *                             out
+ * \param[in] conservative     if set to true, the server should be cautious
+ *                             and limit how much space is granted back to the
+ *                             client. Otherwise, the server should try hard to
+ *                             satisfy the client request.
+ *
+ * \retval                     amount of grant space allocated
  */
-static long ofd_grant(struct obd_export *exp, obd_size curgrant,
-                     obd_size want, obd_size left)
+static long ofd_grant_alloc(struct obd_export *exp, obd_size curgrant,
+                           obd_size want, obd_size left, bool conservative)
 {
        struct obd_device               *obd = exp->exp_obd;
        struct ofd_device               *ofd = ofd_exp(exp);
@@ -603,8 +677,8 @@ static long ofd_grant(struct obd_export *exp, obd_size curgrant,
 
        /* client not supporting OBD_CONNECT_GRANT_PARAM works with a 4KB block
         * size while the reality is different */
-       curgrant    = ofd_grant_from_cli(exp, ofd, curgrant);
-       want    = ofd_grant_from_cli(exp, ofd, want);
+       curgrant = ofd_grant_from_cli(exp, ofd, curgrant);
+       want = ofd_grant_from_cli(exp, ofd, want);
        grant_chunk = ofd_grant_chunk(exp, ofd);
 
        /* Grant some fraction of the client's requested grant space so that
@@ -619,20 +693,23 @@ static long ofd_grant(struct obd_export *exp, obd_size curgrant,
        if (curgrant >= want || curgrant >= fed->fed_grant + grant_chunk)
                   RETURN(0);
 
-       if (!obd->obd_recovering)
+       if (obd->obd_recovering)
+               conservative = false;
+
+       if (conservative)
                /* don't grant more than 1/8th of the remaining free space in
                 * one chunk */
                left >>= 3;
        grant = min(want, left);
-       /* align grant on block size */
-       grant &= ~((1ULL << ofd->ofd_blockbits) - 1);
+       /* round grant upt to the next block size */
+       grant = (grant + (1 << ofd->ofd_blockbits) - 1) &
+               ~((1ULL << ofd->ofd_blockbits) - 1);
 
        if (!grant)
                RETURN(0);
 
-       /* Allow >OFD_GRANT_CHUNK size when clients reconnect due to a
-        * server reboot. */
-       if ((grant > grant_chunk) && (!obd->obd_recovering))
+       /* Limit to ofd_grant_chunk() if not reconnect/recovery */
+       if ((grant > grant_chunk) && conservative)
                grant = grant_chunk;
 
        ofd->ofd_tot_granted += grant;
@@ -642,7 +719,7 @@ static long ofd_grant(struct obd_export *exp, obd_size curgrant,
                CERROR("%s: cli %s/%p grant %ld want "LPU64" current "LPU64"\n",
                       obd->obd_name, exp->exp_client_uuid.uuid, exp,
                       fed->fed_grant, want, curgrant);
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                LBUG();
        }
 
@@ -660,14 +737,23 @@ static long ofd_grant(struct obd_export *exp, obd_size curgrant,
 }
 
 /**
- * Client connection or reconnection.
+ * Handle grant space allocation on client connection & reconnection.
  *
- * \param env - is the lu environment provided by the caller
- * \param exp - is the client's export which is reconnecting
- * \param want - is how much the client would like to get
+ * A new non-readonly connection gets an initial grant allocation equals to
+ * ofd_grant_chunk() (i.e. twice the max BRW size in most of the cases).
+ * On reconnection, grant counters between client & OST are resynchronized
+ * and additional space might be granted back if possible.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] exp      client's export which is (re)connecting
+ * \param[in] want     how much grant space the client would like to get
+ * \param[in] new_conn must set to true if this is a new connection and false
+ *                     for a reconnection
+ *
+ * \retval             amount of grant space currently owned by the client
  */
 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
-                      obd_size want)
+                      obd_size want, bool new_conn)
 {
        struct ofd_device               *ofd = ofd_exp(exp);
        struct filter_export_data       *fed = &exp->exp_filter_data;
@@ -677,14 +763,14 @@ long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
        int                              force = 0; /* can use cached data */
 
        /* don't grant space to client with read-only access */
-       if ((exp->exp_connect_flags & OBD_CONNECT_RDONLY) ||
+       if ((exp_connect_flags(exp) & OBD_CONNECT_RDONLY) ||
            ofd_grant_prohibit(exp, ofd))
                return 0;
 
 refresh:
        ofd_grant_statfs(env, exp, force, &from_cache);
 
-       cfs_spin_lock(&ofd->ofd_grant_lock);
+       spin_lock(&ofd->ofd_grant_lock);
 
        /* Grab free space from cached info and take out space already granted
         * to clients as well as reserved space */
@@ -692,20 +778,21 @@ refresh:
 
        /* get fresh statfs data if we are short in ungranted space */
        if (from_cache && left < 32 * ofd_grant_chunk(exp, ofd)) {
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                CDEBUG(D_CACHE, "fs has no space left and statfs too old\n");
                force = 1;
                goto refresh;
        }
 
-       ofd_grant(exp, ofd_grant_to_cli(exp, ofd, (obd_size)fed->fed_grant),
-                 want, left);
+       ofd_grant_alloc(exp,
+                       ofd_grant_to_cli(exp, ofd, (obd_size)fed->fed_grant),
+                       want, left, new_conn);
 
        /* return to client its current grant */
        grant = ofd_grant_to_cli(exp, ofd, (obd_size)fed->fed_grant);
        ofd->ofd_tot_granted_clients++;
 
-       cfs_spin_unlock(&ofd->ofd_grant_lock);
+       spin_unlock(&ofd->ofd_grant_lock);
 
        CDEBUG(D_CACHE, "%s: cli %s/%p ocd_grant: %ld want: "LPU64" left: "
               LPU64"\n", exp->exp_obd->obd_name, exp->exp_client_uuid.uuid,
@@ -715,12 +802,14 @@ refresh:
 }
 
 /**
+ * Release all grant space attached to a given export.
+ *
  * Remove a client from the grant accounting totals.  We also remove
  * the export from the obd device under the osfs and dev locks to ensure
  * that the ofd_grant_sanity_check() calculations are always valid.
  * The client should do something similar when it invalidates its import.
  *
- * \param exp - is the client's export to remove from grant accounting
+ * \param[in] exp      client's export to remove from grant accounting
  */
 void ofd_grant_discard(struct obd_export *exp)
 {
@@ -728,7 +817,7 @@ void ofd_grant_discard(struct obd_export *exp)
        struct ofd_device               *ofd = ofd_exp(exp);
        struct filter_export_data       *fed = &exp->exp_filter_data;
 
-       cfs_spin_lock(&ofd->ofd_grant_lock);
+       spin_lock(&ofd->ofd_grant_lock);
        LASSERTF(ofd->ofd_tot_granted >= fed->fed_grant,
                 "%s: tot_granted "LPU64" cli %s/%p fed_grant %ld\n",
                 obd->obd_name, ofd->ofd_tot_granted,
@@ -747,17 +836,21 @@ void ofd_grant_discard(struct obd_export *exp)
                 exp->exp_client_uuid.uuid, exp, fed->fed_dirty);
        ofd->ofd_tot_dirty -= fed->fed_dirty;
        fed->fed_dirty = 0;
-       cfs_spin_unlock(&ofd->ofd_grant_lock);
+       spin_unlock(&ofd->ofd_grant_lock);
 }
 
 /**
- * Called at prepare time when handling read request. This function extracts
- * incoming grant information from the obdo and processes the grant shrink
- * request, if any.
+ * Process grant information from incoming bulk read request.
  *
- * \param env - is the lu environment provided by the caller
- * \param exp - is the export of the client which sent the request
- * \paral oa - is the incoming obdo sent by the client
+ * Extract grant information packed in obdo structure (OBD_MD_FLGRANT set in
+ * o_valid). Bulk reads usually comes with grant announcements (number of dirty
+ * blocks, remaining amount of grant space, ...) and could also include a grant
+ * shrink request. Unlike bulk write, no additional grant space is returned on
+ * bulk read request.
+ *
+ * \param[in] env      is the lu environment provided by the caller
+ * \param[in] exp      is the export of the client which sent the request
+ * \paral[in,out] oa   is the incoming obdo sent by the client
  */
 void ofd_grant_prepare_read(const struct lu_env *env,
                            struct obd_export *exp, struct obdo *oa)
@@ -783,7 +876,7 @@ void ofd_grant_prepare_read(const struct lu_env *env,
                ofd_grant_statfs(env, exp, 1, NULL);
 
                /* protect all grant counters */
-               cfs_spin_lock(&ofd->ofd_grant_lock);
+               spin_lock(&ofd->ofd_grant_lock);
 
                /* Grab free space from cached statfs data and take out space
                 * already granted to clients as well as reserved space */
@@ -796,7 +889,7 @@ void ofd_grant_prepare_read(const struct lu_env *env,
                 * since we don't grant space back on reads, no point
                 * in running statfs, so just skip it and process
                 * incoming grant data directly. */
-               cfs_spin_lock(&ofd->ofd_grant_lock);
+               spin_lock(&ofd->ofd_grant_lock);
                do_shrink = 0;
        }
 
@@ -810,18 +903,29 @@ void ofd_grant_prepare_read(const struct lu_env *env,
        else
                oa->o_grant = 0;
 
-       cfs_spin_unlock(&ofd->ofd_grant_lock);
+       spin_unlock(&ofd->ofd_grant_lock);
 }
 
 /**
- * Called at write prepare time to handle incoming grant, check that we have
- * enough space and grant some space back to the client if possible.
+ * Process grant information from incoming bulk write request.
+ *
+ * This function extracts client's grant announcements from incoming bulk write
+ * request and attempts to allocate grant space for network buffers that need it
+ * (i.e. OBD_BRW_FROM_GRANT not set in rnb_fags).
+ * Network buffers which aren't granted the OBD_BRW_GRANTED flag should not
+ * proceed further and should fail with -ENOSPC.
+ * Whenever possible, additional grant space will be returned to the client
+ * in the bulk write reply.
+ * ofd_grant_prepare_write() must be called before writting any buffers to
+ * the backend storage. This function works in pair with ofd_grant_commit()
+ * which must be invoked once all buffers have been written to disk in order
+ * to release space from the pending grant counter.
  *
- * \param env - is the lu environment provided by the caller
- * \param exp - is the export of the client which sent the request
- * \paral oa - is the incoming obdo sent by the client
- * \param rnb - is the list of network buffers
- * \param niocont - is the number of network buffers in the list
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] exp      export of the client which sent the request
+ * \param[in] oa       incoming obdo sent by the client
+ * \param[in] rnb      list of network buffers
+ * \param[in] niocont  number of network buffers in the list
  */
 void ofd_grant_prepare_write(const struct lu_env *env,
                             struct obd_export *exp, struct obdo *oa,
@@ -840,7 +944,7 @@ refresh:
        /* get statfs information from OSD layer */
        ofd_grant_statfs(env, exp, force, &from_cache);
 
-       cfs_spin_lock(&ofd->ofd_grant_lock); /* protect all grant counters */
+       spin_lock(&ofd->ofd_grant_lock); /* protect all grant counters */
 
        /* Grab free space from cached statfs data and take out space already
         * granted to clients as well as reserved space */
@@ -848,7 +952,7 @@ refresh:
 
        /* Get fresh statfs data if we are short in ungranted space */
        if (from_cache && left < 32 * ofd_grant_chunk(exp, ofd)) {
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                CDEBUG(D_CACHE, "%s: fs has no space left and statfs too old\n",
                       obd->obd_name);
                force = 1;
@@ -858,8 +962,7 @@ refresh:
        /* When close to free space exhaustion, trigger a sync to force
         * writeback cache to consume required space immediately and release as
         * much space as possible. */
-       if (!obd->obd_recovering && force != 2 &&
-           left < ofd_grant_chunk(NULL, ofd)) {
+       if (!obd->obd_recovering && force != 2 && left < OFD_GRANT_CHUNK) {
                bool from_grant = true;
                int  i;
 
@@ -873,7 +976,7 @@ refresh:
                if (!from_grant) {
                        /* at least one network buffer requires acquiring grant
                         * space on the server */
-                       cfs_spin_unlock(&ofd->ofd_grant_lock);
+                       spin_unlock(&ofd->ofd_grant_lock);
                        /* discard errors, at least we tried ... */
                        rc = dt_sync(env, ofd->ofd_osd);
                        force = 2;
@@ -888,7 +991,7 @@ refresh:
        ofd_grant_check(env, exp, oa, rnb, niocount, &left);
 
        if (!(oa->o_valid & OBD_MD_FLGRANT)) {
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                RETURN_EXIT;
        }
 
@@ -899,18 +1002,28 @@ refresh:
                ofd_grant_shrink(exp, oa, left);
        else
                /* grant more space back to the client if possible */
-               oa->o_grant = ofd_grant(exp, oa->o_grant, oa->o_undirty, left);
-       cfs_spin_unlock(&ofd->ofd_grant_lock);
+               oa->o_grant = ofd_grant_alloc(exp, oa->o_grant, oa->o_undirty,
+                                             left, true);
+       spin_unlock(&ofd->ofd_grant_lock);
 }
 
 /**
- * Called during object precreation to consume grant space.
- * More space is granted for precreation if possible.
+ * Consume grant space reserved for object creation.
  *
- * \param env - is the lu environment provided by the caller
- * \param exp - is the export holding the grant space for precreation (= self
- *           export currently)
- * \paral nr - is the number of objects the caller wants to create objects
+ * Grant space is allocated to the local self export for object precreation.
+ * This is required to prevent object precreation from consuming grant space
+ * allocated to client nodes for the data writeback cache.
+ * This function consumes enough space to create \a nr objects and allocates
+ * more grant space to the self export for future precreation requests, if
+ * possible.
+ *
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] exp      export holding the grant space for precreation (= self
+ *                     export currently)
+ * \param[in] nr       number of objects to be created
+ *
+ * \retval 0           for success
+ * \retval -ENOSPC     on failure
  */
 int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr)
 {
@@ -919,7 +1032,6 @@ int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr)
        struct filter_export_data       *fed = &exp->exp_filter_data;
        obd_size                         left = 0;
        unsigned long                    wanted;
-
        ENTRY;
 
        info->fti_used = 0;
@@ -933,15 +1045,15 @@ int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr)
        ofd_grant_statfs(env, exp, 1, NULL);
 
        /* protect all grant counters */
-       cfs_spin_lock(&ofd->ofd_grant_lock);
+       spin_lock(&ofd->ofd_grant_lock);
 
        /* fail precreate request if there is not enough blocks available for
         * writing */
        if (ofd->ofd_osfs.os_bavail - (fed->fed_grant >> ofd->ofd_blockbits) <
            (ofd->ofd_osfs.os_blocks >> 10)) {
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                CDEBUG(D_RPCTRACE, "%s: not enough space for create "LPU64"\n",
-                      ofd_obd(ofd)->obd_name,
+                      ofd_name(ofd),
                       ofd->ofd_osfs.os_bavail * ofd->ofd_osfs.os_blocks);
                RETURN(-ENOSPC);
        }
@@ -961,7 +1073,7 @@ int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr)
                if (*nr == 0) {
                        /* we really have no space any more for precreation,
                         * fail the precreate request with ENOSPC */
-                       cfs_spin_unlock(&ofd->ofd_grant_lock);
+                       spin_unlock(&ofd->ofd_grant_lock);
                        RETURN(-ENOSPC);
                }
                /* compute space needed for the new number of creations */
@@ -982,18 +1094,25 @@ int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr)
        fed->fed_pending += info->fti_used;
        ofd->ofd_tot_pending += info->fti_used;
 
-       /* grant more space (twice as much as needed for this request) for
-        * precreate purpose if possible */
-       ofd_grant(exp, fed->fed_grant, wanted * 2, left);
-       cfs_spin_unlock(&ofd->ofd_grant_lock);
+       /* grant more space for precreate purpose if possible. */
+       wanted = OST_MAX_PRECREATE * ofd->ofd_dt_conf.ddp_inodespace / 2;
+       if (wanted > fed->fed_grant) {
+               /* always try to book enough space to handle a large precreate
+                * request */
+               wanted -= fed->fed_grant;
+               ofd_grant_alloc(exp, fed->fed_grant, wanted, left, false);
+       }
+       spin_unlock(&ofd->ofd_grant_lock);
        RETURN(0);
 }
 
 /**
- * Called at commit time to update pending grant counter for writes in flight
+ * Release grant space added to the pending counter by ofd_grant_prepare_write()
+ *
+ * Update pending grant counter once buffers have been written to the disk.
  *
- * \param env - is the lu environment provided by the caller
- * \param exp - is the export of the client which sent the request
+ * \param[in] env      LU environment provided by the caller
+ * \param[in] exp      export of the client which sent the request
  */
 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
                      int rc)
@@ -1010,7 +1129,7 @@ void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
        if (pending == 0)
                RETURN_EXIT;
 
-       cfs_spin_lock(&ofd->ofd_grant_lock);
+       spin_lock(&ofd->ofd_grant_lock);
        /* Don't update statfs data for errors raised before commit (e.g.
         * bulk transfer failed, ...) since we know those writes have not been
         * processed. For other errors hit during commit, we cannot really tell
@@ -1018,7 +1137,7 @@ void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
         * In any case, this should not be fatal since we always get fresh
         * statfs data before failing a request with ENOSPC */
        if (rc == 0) {
-               cfs_spin_lock(&ofd->ofd_osfs_lock);
+               spin_lock(&ofd->ofd_osfs_lock);
                /* Take pending out of cached statfs data */
                ofd->ofd_osfs.os_bavail -= min_t(obd_size,
                                                 ofd->ofd_osfs.os_bavail,
@@ -1027,14 +1146,14 @@ void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
                        /* someone is running statfs and want to be notified of
                         * writes happening meanwhile */
                        ofd->ofd_osfs_inflight += pending;
-               cfs_spin_unlock(&ofd->ofd_osfs_lock);
+               spin_unlock(&ofd->ofd_osfs_lock);
        }
 
        if (exp->exp_filter_data.fed_pending < pending) {
                CERROR("%s: cli %s/%p fed_pending(%lu) < grant_used(%lu)\n",
                       exp->exp_obd->obd_name, exp->exp_client_uuid.uuid, exp,
                       exp->exp_filter_data.fed_pending, pending);
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                LBUG();
        }
        exp->exp_filter_data.fed_pending -= pending;
@@ -1044,7 +1163,7 @@ void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
                        "\n", exp->exp_obd->obd_name,
                        exp->exp_client_uuid.uuid, exp, ofd->ofd_tot_granted,
                        pending);
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                LBUG();
        }
        ofd->ofd_tot_granted -= pending;
@@ -1053,10 +1172,10 @@ void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
                 CERROR("%s: cli %s/%p tot_pending("LPU64") < grant_used(%lu)"
                        "\n", exp->exp_obd->obd_name, exp->exp_client_uuid.uuid,
                        exp, ofd->ofd_tot_pending, pending);
-               cfs_spin_unlock(&ofd->ofd_grant_lock);
+               spin_unlock(&ofd->ofd_grant_lock);
                LBUG();
        }
        ofd->ofd_tot_pending -= pending;
-       cfs_spin_unlock(&ofd->ofd_grant_lock);
+       spin_unlock(&ofd->ofd_grant_lock);
        EXIT;
 }