lustre/ofd/ofd_grant.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/ofd/ofd_grant.c
  37  *
  38  * Author: Johann Lombardi <johann@whamcloud..com>
  39  */
  40
  41 #define DEBUG_SUBSYSTEM S_FILTER
  42
  43 #include "ofd_internal.h"
  44
  45 /* At least enough to send a couple of 1MB RPCs, even if not max sized */
  46 #define OFD_GRANT_CHUNK                 (2ULL * DT_MAX_BRW_SIZE)
  47
  48 /* Clients typically hold 2x their max_rpcs_in_flight of grant space */
  49 #define OFD_GRANT_SHRINK_LIMIT(exp)     (2ULL * 8 * exp_max_brw_size(exp))
  50
  51 static inline obd_size ofd_grant_from_cli(struct obd_export *exp,
  52                                           struct ofd_device *ofd, obd_size val)
  53 {
  54         if (ofd_grant_compat(exp, ofd))
  55                 /* clients not supporting OBD_CONNECT_GRANT_PARAM actually
  56                  * consume 4KB of grant per block, we should thus inflate
  57                  * the grant counters to reflect what was actually consumed */
  58                 return val << (ofd->ofd_blockbits - COMPAT_BSIZE_SHIFT);
  59         return val;
  60 }
  61
  62 static inline obd_size ofd_grant_to_cli(struct obd_export *exp,
  63                                         struct ofd_device *ofd, obd_size val)
  64 {
  65         if (ofd_grant_compat(exp, ofd))
  66                 return val >> (ofd->ofd_blockbits - COMPAT_BSIZE_SHIFT);
  67         return val;
  68 }
  69
  70 static inline obd_size ofd_grant_chunk(struct obd_export *exp,
  71                                        struct ofd_device *ofd)
  72 {
  73         if (ofd_obd(ofd)->obd_self_export == exp)
  74                 /* Grant enough space to handle a big precreate request */
  75                 return OST_MAX_PRECREATE * ofd->ofd_dt_conf.ddp_inodespace;
  76
  77         if (ofd_grant_compat(exp, ofd))
  78                 /* Try to grant enough space to send a full-size RPC */
  79                 return exp_max_brw_size(exp) <<
  80                        (ofd->ofd_blockbits - COMPAT_BSIZE_SHIFT);
  81
  82         /* Try to return enough to send two full RPCs, if needed */
  83         return exp_max_brw_size(exp) * 2;
  84 }
  85
  86 /**
  87  * Perform extra sanity checks for grant accounting. This is done at connect,
  88  * disconnect, and statfs RPC time, so it shouldn't be too bad. We can
  89  * always get rid of it or turn it off when we know accounting is good.
  90  *
  91  * \param obd - is the device to check
  92  * \param func - is the function to call if an inconsistency is found
  93  */
  94 void ofd_grant_sanity_check(struct obd_device *obd, const char *func)
  95 {
  96         struct filter_export_data       *fed;
  97         struct ofd_device               *ofd = ofd_dev(obd->obd_lu_dev);
  98         struct obd_export               *exp;
  99         obd_size                         maxsize;
 100         obd_size                         tot_dirty = 0;
 101         obd_size                         tot_pending = 0;
 102         obd_size                         tot_granted = 0;
 103         obd_size                         fo_tot_dirty, fo_tot_pending;
 104         obd_size                         fo_tot_granted;
 105
 106         if (cfs_list_empty(&obd->obd_exports))
 107                 return;
 108
 109         /* We don't want to do this for large machines that do lots of
 110          * mounts or unmounts.  It burns... */
 111         if (obd->obd_num_exports > 100)
 112                 return;
 113
 114         maxsize = ofd->ofd_osfs.os_blocks << ofd->ofd_blockbits;
 115
 116         spin_lock(&obd->obd_dev_lock);
 117         spin_lock(&ofd->ofd_grant_lock);
 118         cfs_list_for_each_entry(exp, &obd->obd_exports, exp_obd_chain) {
 119                 int error = 0;
 120
 121                 fed = &exp->exp_filter_data;
 122
 123                 if (obd->obd_self_export == exp)
 124                         CDEBUG(D_CACHE, "%s: processing self export: %ld %ld "
 125                                "%ld\n", obd->obd_name, fed->fed_grant,
 126                                fed->fed_pending, fed->fed_dirty);
 127
 128                 if (fed->fed_grant < 0 || fed->fed_pending < 0 ||
 129                     fed->fed_dirty < 0)
 130                         error = 1;
 131                 if (fed->fed_grant + fed->fed_pending > maxsize) {
 132                         CERROR("%s: cli %s/%p fed_grant(%ld) + fed_pending(%ld)"
 133                                " > maxsize("LPU64")\n", obd->obd_name,
 134                                exp->exp_client_uuid.uuid, exp, fed->fed_grant,
 135                                fed->fed_pending, maxsize);
 136                         spin_unlock(&obd->obd_dev_lock);
 137                         spin_unlock(&ofd->ofd_grant_lock);
 138                         LBUG();
 139                 }
 140                 if (fed->fed_dirty > maxsize) {
 141                         CERROR("%s: cli %s/%p fed_dirty(%ld) > maxsize("LPU64
 142                                ")\n", obd->obd_name, exp->exp_client_uuid.uuid,
 143                                exp, fed->fed_dirty, maxsize);
 144                         spin_unlock(&obd->obd_dev_lock);
 145                         spin_unlock(&ofd->ofd_grant_lock);
 146                         LBUG();
 147                 }
 148                 CDEBUG_LIMIT(error ? D_ERROR : D_CACHE, "%s: cli %s/%p dirty "
 149                              "%ld pend %ld grant %ld\n", obd->obd_name,
 150                              exp->exp_client_uuid.uuid, exp, fed->fed_dirty,
 151                              fed->fed_pending, fed->fed_grant);
 152                 tot_granted += fed->fed_grant + fed->fed_pending;
 153                 tot_pending += fed->fed_pending;
 154                 tot_dirty += fed->fed_dirty;
 155         }
 156         spin_unlock(&obd->obd_dev_lock);
 157         fo_tot_granted = ofd->ofd_tot_granted;
 158         fo_tot_pending = ofd->ofd_tot_pending;
 159         fo_tot_dirty = ofd->ofd_tot_dirty;
 160
 161         if (tot_granted != fo_tot_granted)
 162                 CERROR("%s: tot_granted "LPU64" != fo_tot_granted "LPU64"\n",
 163                        func, tot_granted, fo_tot_granted);
 164         if (tot_pending != fo_tot_pending)
 165                 CERROR("%s: tot_pending "LPU64" != fo_tot_pending "LPU64"\n",
 166                        func, tot_pending, fo_tot_pending);
 167         if (tot_dirty != fo_tot_dirty)
 168                 CERROR("%s: tot_dirty "LPU64" != fo_tot_dirty "LPU64"\n",
 169                        func, tot_dirty, fo_tot_dirty);
 170         if (tot_pending > tot_granted)
 171                 CERROR("%s: tot_pending "LPU64" > tot_granted "LPU64"\n",
 172                        func, tot_pending, tot_granted);
 173         if (tot_granted > maxsize)
 174                 CERROR("%s: tot_granted "LPU64" > maxsize "LPU64"\n",
 175                        func, tot_granted, maxsize);
 176         if (tot_dirty > maxsize)
 177                 CERROR("%s: tot_dirty "LPU64" > maxsize "LPU64"\n",
 178                        func, tot_dirty, maxsize);
 179         spin_unlock(&ofd->ofd_grant_lock);
 180 }
 181
 182 /**
 183  * Get fresh statfs information from the OSD layer if the cache is older than 1s
 184  * or if force is set. The OSD layer is in charge of estimating data & metadata
 185  * overhead.
 186  *
 187  * \param env - is the lu environment passed by the caller
 188  * \param exp - export used to print client info in debug messages
 189  * \param force - is used to force a refresh of statfs information
 190  * \param from_cache - returns whether the statfs information are
 191  *                   taken from cache
 192  */
 193 static void ofd_grant_statfs(const struct lu_env *env, struct obd_export *exp,
 194                              int force, int *from_cache)
 195 {
 196         struct obd_device       *obd = exp->exp_obd;
 197         struct ofd_device       *ofd = ofd_exp(exp);
 198         struct obd_statfs       *osfs = &ofd_info(env)->fti_u.osfs;
 199         __u64                    max_age;
 200         int                      rc;
 201
 202         if (force)
 203                 max_age = 0; /* get fresh statfs data */
 204         else
 205                 max_age = cfs_time_shift_64(-OBD_STATFS_CACHE_SECONDS);
 206
 207         rc = ofd_statfs_internal(env, ofd, osfs, max_age, from_cache);
 208         if (unlikely(rc)) {
 209                 *from_cache = 0;
 210                 return;
 211         }
 212
 213         CDEBUG(D_CACHE, "%s: cli %s/%p free: "LPU64" avail: "LPU64"\n",
 214                obd->obd_name, exp->exp_client_uuid.uuid, exp,
 215                osfs->os_bfree << ofd->ofd_blockbits,
 216                osfs->os_bavail << ofd->ofd_blockbits);
 217 }
 218
 219 /**
 220  * Figure out how much space is available on the backend filesystem.
 221  * This is done by accessing cached statfs data previously populated by
 222  * ofd_grant_statfs(), from which we withdraw the space already granted to
 223  * clients and the reserved space.
 224  *
 225  * \param exp - export which received the write request
 226  */
 227 static obd_size ofd_grant_space_left(struct obd_export *exp)
 228 {
 229         struct obd_device       *obd = exp->exp_obd;
 230         struct ofd_device       *ofd = ofd_exp(exp);
 231         obd_size                 tot_granted;
 232         obd_size                 left, avail;
 233         obd_size                 unstable;
 234
 235         ENTRY;
 236         LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
 237
 238         spin_lock(&ofd->ofd_osfs_lock);
 239         /* get available space from cached statfs data */
 240         left = ofd->ofd_osfs.os_bavail << ofd->ofd_blockbits;
 241         unstable = ofd->ofd_osfs_unstable; /* those might be accounted twice */
 242         spin_unlock(&ofd->ofd_osfs_lock);
 243
 244         tot_granted = ofd->ofd_tot_granted;
 245
 246         if (left < tot_granted) {
 247                 int mask = (left + unstable <
 248                             tot_granted - ofd->ofd_tot_pending) ?
 249                             D_ERROR : D_CACHE;
 250
 251                 CDEBUG_LIMIT(mask, "%s: cli %s/%p left "LPU64" < tot_grant "
 252                              LPU64" unstable "LPU64" pending "LPU64"\n",
 253                              obd->obd_name, exp->exp_client_uuid.uuid, exp,
 254                              left, tot_granted, unstable,
 255                              ofd->ofd_tot_pending);
 256                 RETURN(0);
 257         }
 258
 259         avail = left;
 260         /* Withdraw space already granted to clients */
 261         left -= tot_granted;
 262
 263         /* If the left space is below the grant threshold x available space,
 264          * stop granting space to clients.
 265          * The purpose of this threshold is to keep some error margin on the
 266          * overhead estimate made by the OSD layer. If we grant all the free
 267          * space, we have no way (grant space cannot be revoked yet) to
 268          * adjust if the write overhead has been underestimated. */
 269         left -= min_t(obd_size, left, ofd_grant_reserved(ofd, avail));
 270
 271         /* Align left on block size */
 272         left &= ~((1ULL << ofd->ofd_blockbits) - 1);
 273
 274         CDEBUG(D_CACHE, "%s: cli %s/%p avail "LPU64" left "LPU64" unstable "
 275                LPU64" tot_grant "LPU64" pending "LPU64"\n", obd->obd_name,
 276                exp->exp_client_uuid.uuid, exp, avail, left, unstable,
 277                tot_granted, ofd->ofd_tot_pending);
 278
 279         RETURN(left);
 280 }
 281
 282 /**
 283  * Grab the dirty and seen grant announcements from the incoming obdo.
 284  * We will later calculate the client's new grant and return it.
 285  * Caller must hold ofd_grant_lock spinlock.
 286  *
 287  * \param env - is the lu environment supplying osfs storage
 288  * \param exp - is the export for which we received the request
 289  * \paral oa - is the incoming obdo sent by the client
 290  */
 291 static void ofd_grant_incoming(const struct lu_env *env, struct obd_export *exp,
 292                                struct obdo *oa)
 293 {
 294         struct filter_export_data       *fed;
 295         struct ofd_device               *ofd = ofd_exp(exp);
 296         struct obd_device               *obd = exp->exp_obd;
 297         long                             dirty, dropped, grant_chunk;
 298         ENTRY;
 299
 300         LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
 301
 302         if ((oa->o_valid & (OBD_MD_FLBLOCKS|OBD_MD_FLGRANT)) !=
 303                                         (OBD_MD_FLBLOCKS|OBD_MD_FLGRANT)) {
 304                 oa->o_valid &= ~OBD_MD_FLGRANT;
 305                 RETURN_EXIT;
 306         }
 307
 308         fed = &exp->exp_filter_data;
 309
 310         /* Add some margin, since there is a small race if other RPCs arrive
 311          * out-or-order and have already consumed some grant.  We want to
 312          * leave this here in case there is a large error in accounting. */
 313         CDEBUG(D_CACHE,
 314                "%s: cli %s/%p reports grant "LPU64" dropped %u, local %lu\n",
 315                obd->obd_name, exp->exp_client_uuid.uuid, exp, oa->o_grant,
 316                oa->o_dropped, fed->fed_grant);
 317
 318         if ((long long)oa->o_dirty < 0)
 319                 oa->o_dirty = 0;
 320
 321         dirty       = ofd_grant_from_cli(exp, ofd, oa->o_dirty);
 322         dropped     = ofd_grant_from_cli(exp, ofd, (obd_size)oa->o_dropped);
 323         grant_chunk = ofd_grant_chunk(exp, ofd);
 324
 325         /* Update our accounting now so that statfs takes it into account.
 326          * Note that fed_dirty is only approximate and can become incorrect
 327          * if RPCs arrive out-of-order.  No important calculations depend
 328          * on fed_dirty however, but we must check sanity to not assert. */
 329         if (dirty > fed->fed_grant + 4 * grant_chunk)
 330                 dirty = fed->fed_grant + 4 * grant_chunk;
 331         ofd->ofd_tot_dirty += dirty - fed->fed_dirty;
 332         if (fed->fed_grant < dropped) {
 333                 CDEBUG(D_CACHE,
 334                        "%s: cli %s/%p reports %lu dropped > grant %lu\n",
 335                        obd->obd_name, exp->exp_client_uuid.uuid, exp, dropped,
 336                        fed->fed_grant);
 337                 dropped = 0;
 338         }
 339         if (ofd->ofd_tot_granted < dropped) {
 340                 CERROR("%s: cli %s/%p reports %lu dropped > tot_grant "LPU64
 341                        "\n", obd->obd_name, exp->exp_client_uuid.uuid, exp,
 342                        dropped, ofd->ofd_tot_granted);
 343                 dropped = 0;
 344         }
 345         ofd->ofd_tot_granted -= dropped;
 346         fed->fed_grant -= dropped;
 347         fed->fed_dirty = dirty;
 348
 349         if (fed->fed_dirty < 0 || fed->fed_grant < 0 || fed->fed_pending < 0) {
 350                 CERROR("%s: cli %s/%p dirty %ld pend %ld grant %ld\n",
 351                        obd->obd_name, exp->exp_client_uuid.uuid, exp,
 352                        fed->fed_dirty, fed->fed_pending, fed->fed_grant);
 353                 spin_unlock(&ofd->ofd_grant_lock);
 354                 LBUG();
 355         }
 356         EXIT;
 357 }
 358
 359 /**
 360  * Called when the client is able to release some grants. Proceed with the
 361  * shrink request when there is less ungranted space remaining
 362  * than the amount all of the connected clients would consume if they
 363  * used their full grant.
 364  *
 365  * \param exp - is the export for which we received the request
 366  * \paral oa - is the incoming obdo sent by the client
 367  * \param left_space - is the remaining free space with space already granted
 368  *                   taken out
 369  */
 370 static void ofd_grant_shrink(struct obd_export *exp,
 371                              struct obdo *oa, obd_size left_space)
 372 {
 373         struct filter_export_data       *fed;
 374         struct ofd_device               *ofd = ofd_exp(exp);
 375         struct obd_device               *obd = exp->exp_obd;
 376         long                             grant_shrink;
 377
 378         LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
 379         LASSERT(exp);
 380         if (left_space >= ofd->ofd_tot_granted_clients *
 381                           OFD_GRANT_SHRINK_LIMIT(exp))
 382                 return;
 383
 384         grant_shrink = ofd_grant_from_cli(exp, ofd, oa->o_grant);
 385
 386         fed = &exp->exp_filter_data;
 387         fed->fed_grant       -= grant_shrink;
 388         ofd->ofd_tot_granted -= grant_shrink;
 389
 390         CDEBUG(D_CACHE, "%s: cli %s/%p shrink %ld fed_grant %ld total "
 391                LPU64"\n", obd->obd_name, exp->exp_client_uuid.uuid,
 392                exp, grant_shrink, fed->fed_grant, ofd->ofd_tot_granted);
 393
 394         /* client has just released some grant, don't grant any space back */
 395         oa->o_grant = 0;
 396 }
 397
 398 /**
 399  * Calculate how much space is required to write a given network buffer
 400  */
 401 static inline int ofd_grant_rnb_size(struct obd_export *exp,
 402                                      struct ofd_device *ofd,
 403                                      struct niobuf_remote *rnb)
 404 {
 405         obd_size blocksize, bytes, end;
 406
 407         if (exp && ofd_grant_compat(exp, ofd))
 408                 blocksize = 1ULL << COMPAT_BSIZE_SHIFT;
 409         else
 410                 blocksize = 1ULL << ofd->ofd_blockbits;
 411
 412         /* The network buffer might span several blocks, align it on block
 413          * boundaries */
 414         bytes  = rnb->rnb_offset & (blocksize - 1);
 415         bytes += rnb->rnb_len;
 416         end    = bytes & (blocksize - 1);
 417         if (end)
 418                 bytes += blocksize - end;
 419         if (exp)
 420                 /* Apply per-export pecularities if one is given */
 421                 bytes = ofd_grant_from_cli(exp, ofd, (obd_size)bytes);
 422         return bytes;
 423 }
 424
 425
 426 /**
 427  * When clients have dirtied as much space as they've been granted they
 428  * fall through to sync writes.  These sync writes haven't been expressed
 429  * in grants and need to error with ENOSPC when there isn't room in the
 430  * filesystem for them after grants are taken into account.  However,
 431  * writeback of the dirty data that was already granted space can write
 432  * right on through.
 433  * Caller must hold ofd_grant_lock spinlock.
 434  *
 435  * \param env - is the lu environment passed by the caller
 436  * \param exp - is the export identifying the client which sent the RPC
 437  * \param oa  - is the incoming obdo in which we should return the pack the
 438  *            additional grant
 439  * \param rnb - is the list of network buffers
 440  * \param niocont - is the number of network buffers in the list
 441  * \param left - is the remaining free space with space already granted
 442  *             taken out
 443  */
 444 static void ofd_grant_check(const struct lu_env *env, struct obd_export *exp,
 445                             struct obdo *oa, struct niobuf_remote *rnb,
 446                             int niocount, obd_size *left)
 447 {
 448         struct filter_export_data       *fed = &exp->exp_filter_data;
 449         struct obd_device               *obd = exp->exp_obd;
 450         struct ofd_device               *ofd = ofd_exp(exp);
 451         unsigned long                    ungranted = 0;
 452         unsigned long                    granted = 0;
 453         int                              i;
 454         int                              resend = 0;
 455         struct ofd_thread_info          *info = ofd_info(env);
 456
 457         ENTRY;
 458
 459         LASSERT_SPIN_LOCKED(&ofd->ofd_grant_lock);
 460
 461         if ((oa->o_valid & OBD_MD_FLFLAGS) &&
 462             (oa->o_flags & OBD_FL_RECOV_RESEND)) {
 463                 resend = 1;
 464                 CDEBUG(D_CACHE, "Recoverable resend arrived, skipping "
 465                                 "accounting\n");
 466         }
 467
 468         for (i = 0; i < niocount; i++) {
 469                 int bytes;
 470
 471                 if (obd->obd_recovering) {
 472                         /* Replaying write. Grant info have been processed
 473                          * already so no need to do any enforcement here.
 474                          * It is worth noting that only bulk writes with all
 475                          * rnbs having OBD_BRW_FROM_GRANT can be replayed.
 476                          * If one page hasn't OBD_BRW_FROM_GRANT set, then
 477                          * the whole bulk is written synchronously */
 478                         if (rnb[i].rnb_flags & OBD_BRW_FROM_GRANT) {
 479                                  rnb[i].rnb_flags |= OBD_BRW_GRANTED;
 480                                  continue;
 481                         } else {
 482                                 CERROR("%s: cli %s is replaying OST_WRITE "
 483                                        "while one rnb hasn't OBD_BRW_FROM_GRANT"
 484                                        " set (0x%x)\n", exp->exp_obd->obd_name,
 485                                         exp->exp_client_uuid.uuid,
 486                                         rnb[i].rnb_flags);
 487
 488                         }
 489                 } else if ((oa->o_valid & OBD_MD_FLGRANT) &&
 490                            (rnb[i].rnb_flags & OBD_BRW_FROM_GRANT)) {
 491                         if (resend) {
 492                                 /* This is a recoverable resend so grant
 493                                  * information have already been processed */
 494                                 rnb[i].rnb_flags |= OBD_BRW_GRANTED;
 495                                 continue;
 496                         }
 497
 498                         /* inflate consumed space if needed */
 499                         bytes = ofd_grant_rnb_size(exp, ofd, &rnb[i]);
 500                         if (fed->fed_grant < granted + bytes) {
 501                                 CDEBUG(D_CACHE, "%s: cli %s/%p claims %ld+%d "
 502                                        "GRANT, real grant %lu idx %d\n",
 503                                        exp->exp_obd->obd_name,
 504                                        exp->exp_client_uuid.uuid, exp,
 505                                        granted, bytes, fed->fed_grant, i);
 506                         } else {
 507                                 granted += bytes;
 508                                 rnb[i].rnb_flags |= OBD_BRW_GRANTED;
 509                                 continue;
 510                         }
 511                 }
 512
 513                 /* Consume grant space on the server.
 514                  * Unlike above, ofd_grant_rnb_size() is called with exp = NULL
 515                  * so that the required grant space isn't inflated. This is
 516                  * done on purpose since the server can deal with large block
 517                  * size, unlike some clients */
 518                 bytes = ofd_grant_rnb_size(NULL, ofd, &rnb[i]);
 519                 if (*left > ungranted + bytes) {
 520                         /* if enough space, pretend it was granted */
 521                         ungranted += bytes;
 522                         rnb[i].rnb_flags |= OBD_BRW_GRANTED;
 523                         continue;
 524                 }
 525
 526                 /* We can't check for already-mapped blocks here (make sense
 527                  * when backend filesystem does not use COW) as it requires
 528                  * dropping the grant lock.
 529                  * Instead, we clear ~OBD_BRW_GRANTED and in that case we need
 530                  * to go through and verify if all of the blocks not marked
 531                  *  BRW_GRANTED are already mapped and we can ignore this error.
 532                  */
 533                 rnb[i].rnb_flags &= ~OBD_BRW_GRANTED;
 534                 CDEBUG(D_CACHE,"%s: cli %s/%p idx %d no space for %d\n",
 535                                 exp->exp_obd->obd_name,
 536                                 exp->exp_client_uuid.uuid, exp, i, bytes);
 537         }
 538
 539         /* record space used for the I/O, will be used in ofd_grant_commmit() */
 540         /* Now substract what the clients has used already.  We don't subtract
 541          * this from the tot_granted yet, so that other client's can't grab
 542          * that space before we have actually allocated our blocks. That
 543          * happens in ofd_grant_commit() after the writes are done. */
 544         info->fti_used = granted + ungranted;
 545         *left -= ungranted;
 546         fed->fed_grant -= granted;
 547         fed->fed_pending += info->fti_used;
 548         ofd->ofd_tot_granted += ungranted;
 549         ofd->ofd_tot_pending += info->fti_used;
 550
 551         CDEBUG(D_CACHE,
 552                "%s: cli %s/%p granted: %lu ungranted: %lu grant: %lu dirty: %lu"
 553                "\n", obd->obd_name, exp->exp_client_uuid.uuid, exp,
 554                granted, ungranted, fed->fed_grant, fed->fed_dirty);
 555
 556         if (obd->obd_recovering)
 557                 /* don't update dirty accounting during recovery */
 558                 RETURN_EXIT;
 559
 560         if (fed->fed_dirty < granted) {
 561                 CWARN("%s: cli %s/%p claims granted %lu > fed_dirty %lu\n",
 562                        obd->obd_name, exp->exp_client_uuid.uuid, exp,
 563                        granted, fed->fed_dirty);
 564                 granted = fed->fed_dirty;
 565         }
 566         ofd->ofd_tot_dirty -= granted;
 567         fed->fed_dirty -= granted;
 568
 569         if (fed->fed_dirty < 0 || fed->fed_grant < 0 || fed->fed_pending < 0) {
 570                 CERROR("%s: cli %s/%p dirty %ld pend %ld grant %ld\n",
 571                        obd->obd_name, exp->exp_client_uuid.uuid, exp,
 572                        fed->fed_dirty, fed->fed_pending, fed->fed_grant);
 573                 spin_unlock(&ofd->ofd_grant_lock);
 574                 LBUG();
 575         }
 576         EXIT;
 577 }
 578
 579 /**
 580  * Calculate how much grant space to return to client, based on how much space
 581  * is currently free and how much of that is already granted.
 582  * Caller must hold ofd_grant_lock spinlock.
 583  *
 584  * \param exp - is the export of the client which sent the request
 585  * \param curgrant - is the current grant claimed by the client
 586  * \param want - is how much grant space the client would like to have
 587  * \param left - is the remaining free space with granted space taken out
 588  */
 589 static long ofd_grant(struct obd_export *exp, obd_size curgrant,
 590                       obd_size want, obd_size left)
 591 {
 592         struct obd_device               *obd = exp->exp_obd;
 593         struct ofd_device               *ofd = ofd_exp(exp);
 594         struct filter_export_data       *fed = &exp->exp_filter_data;
 595         long                             grant_chunk;
 596         obd_size                         grant;
 597
 598         ENTRY;
 599
 600         if (ofd_grant_prohibit(exp, ofd) || left == 0 || exp->exp_failed)
 601                 RETURN(0);
 602
 603         if (want > 0x7fffffff) {
 604                 CERROR("%s: client %s/%p requesting > 2GB grant "LPU64"\n",
 605                        obd->obd_name, exp->exp_client_uuid.uuid, exp, want);
 606                 RETURN(0);
 607         }
 608
 609         /* client not supporting OBD_CONNECT_GRANT_PARAM works with a 4KB block
 610          * size while the reality is different */
 611         curgrant    = ofd_grant_from_cli(exp, ofd, curgrant);
 612         want    = ofd_grant_from_cli(exp, ofd, want);
 613         grant_chunk = ofd_grant_chunk(exp, ofd);
 614
 615         /* Grant some fraction of the client's requested grant space so that
 616          * they are not always waiting for write credits (not all of it to
 617          * avoid overgranting in face of multiple RPCs in flight).  This
 618          * essentially will be able to control the OSC_MAX_RIF for a client.
 619          *
 620          * If we do have a large disparity between what the client thinks it
 621          * has and what we think it has, don't grant very much and let the
 622          * client consume its grant first.  Either it just has lots of RPCs
 623          * in flight, or it was evicted and its grants will soon be used up. */
 624         if (curgrant >= want || curgrant >= fed->fed_grant + grant_chunk)
 625                    RETURN(0);
 626
 627         if (!obd->obd_recovering)
 628                 /* don't grant more than 1/8th of the remaining free space in
 629                  * one chunk */
 630                 left >>= 3;
 631         grant = min(want, left);
 632         /* align grant on block size */
 633         grant &= ~((1ULL << ofd->ofd_blockbits) - 1);
 634
 635         if (!grant)
 636                 RETURN(0);
 637
 638         /* Limit to ofd_grant_chunk() if client is not reconnecting */
 639         if ((grant > grant_chunk) && (!obd->obd_recovering))
 640                 grant = grant_chunk;
 641
 642         ofd->ofd_tot_granted += grant;
 643         fed->fed_grant += grant;
 644
 645         if (fed->fed_grant < 0) {
 646                 CERROR("%s: cli %s/%p grant %ld want "LPU64" current "LPU64"\n",
 647                        obd->obd_name, exp->exp_client_uuid.uuid, exp,
 648                        fed->fed_grant, want, curgrant);
 649                 spin_unlock(&ofd->ofd_grant_lock);
 650                 LBUG();
 651         }
 652
 653         CDEBUG(D_CACHE,
 654                "%s: cli %s/%p wants: "LPU64" current grant "LPU64
 655                " granting: "LPU64"\n", obd->obd_name, exp->exp_client_uuid.uuid,
 656                exp, want, curgrant, grant);
 657         CDEBUG(D_CACHE,
 658                "%s: cli %s/%p tot cached:"LPU64" granted:"LPU64
 659                " num_exports: %d\n", obd->obd_name, exp->exp_client_uuid.uuid,
 660                exp, ofd->ofd_tot_dirty, ofd->ofd_tot_granted,
 661                obd->obd_num_exports);
 662
 663         RETURN(ofd_grant_to_cli(exp, ofd, grant));
 664 }
 665
 666 /**
 667  * Client connection or reconnection.
 668  *
 669  * \param env - is the lu environment provided by the caller
 670  * \param exp - is the client's export which is reconnecting
 671  * \param want - is how much the client would like to get
 672  */
 673 long ofd_grant_connect(const struct lu_env *env, struct obd_export *exp,
 674                        obd_size want)
 675 {
 676         struct ofd_device               *ofd = ofd_exp(exp);
 677         struct filter_export_data       *fed = &exp->exp_filter_data;
 678         obd_size                         left = 0;
 679         long                             grant;
 680         int                              from_cache;
 681         int                              force = 0; /* can use cached data */
 682
 683         /* don't grant space to client with read-only access */
 684         if ((exp_connect_flags(exp) & OBD_CONNECT_RDONLY) ||
 685             ofd_grant_prohibit(exp, ofd))
 686                 return 0;
 687
 688 refresh:
 689         ofd_grant_statfs(env, exp, force, &from_cache);
 690
 691         spin_lock(&ofd->ofd_grant_lock);
 692
 693         /* Grab free space from cached info and take out space already granted
 694          * to clients as well as reserved space */
 695         left = ofd_grant_space_left(exp);
 696
 697         /* get fresh statfs data if we are short in ungranted space */
 698         if (from_cache && left < 32 * ofd_grant_chunk(exp, ofd)) {
 699                 spin_unlock(&ofd->ofd_grant_lock);
 700                 CDEBUG(D_CACHE, "fs has no space left and statfs too old\n");
 701                 force = 1;
 702                 goto refresh;
 703         }
 704
 705         ofd_grant(exp, ofd_grant_to_cli(exp, ofd, (obd_size)fed->fed_grant),
 706                   want, left);
 707
 708         /* return to client its current grant */
 709         grant = ofd_grant_to_cli(exp, ofd, (obd_size)fed->fed_grant);
 710         ofd->ofd_tot_granted_clients++;
 711
 712         spin_unlock(&ofd->ofd_grant_lock);
 713
 714         CDEBUG(D_CACHE, "%s: cli %s/%p ocd_grant: %ld want: "LPU64" left: "
 715                LPU64"\n", exp->exp_obd->obd_name, exp->exp_client_uuid.uuid,
 716                exp, grant, want, left);
 717
 718         return grant;
 719 }
 720
 721 /**
 722  * Remove a client from the grant accounting totals.  We also remove
 723  * the export from the obd device under the osfs and dev locks to ensure
 724  * that the ofd_grant_sanity_check() calculations are always valid.
 725  * The client should do something similar when it invalidates its import.
 726  *
 727  * \param exp - is the client's export to remove from grant accounting
 728  */
 729 void ofd_grant_discard(struct obd_export *exp)
 730 {
 731         struct obd_device               *obd = exp->exp_obd;
 732         struct ofd_device               *ofd = ofd_exp(exp);
 733         struct filter_export_data       *fed = &exp->exp_filter_data;
 734
 735         spin_lock(&ofd->ofd_grant_lock);
 736         LASSERTF(ofd->ofd_tot_granted >= fed->fed_grant,
 737                  "%s: tot_granted "LPU64" cli %s/%p fed_grant %ld\n",
 738                  obd->obd_name, ofd->ofd_tot_granted,
 739                  exp->exp_client_uuid.uuid, exp, fed->fed_grant);
 740         ofd->ofd_tot_granted -= fed->fed_grant;
 741         fed->fed_grant = 0;
 742         LASSERTF(ofd->ofd_tot_pending >= fed->fed_pending,
 743                  "%s: tot_pending "LPU64" cli %s/%p fed_pending %ld\n",
 744                  obd->obd_name, ofd->ofd_tot_pending,
 745                  exp->exp_client_uuid.uuid, exp, fed->fed_pending);
 746         /* ofd_tot_pending is handled in ofd_grant_commit as bulk
 747          * finishes */
 748         LASSERTF(ofd->ofd_tot_dirty >= fed->fed_dirty,
 749                  "%s: tot_dirty "LPU64" cli %s/%p fed_dirty %ld\n",
 750                  obd->obd_name, ofd->ofd_tot_dirty,
 751                  exp->exp_client_uuid.uuid, exp, fed->fed_dirty);
 752         ofd->ofd_tot_dirty -= fed->fed_dirty;
 753         fed->fed_dirty = 0;
 754         spin_unlock(&ofd->ofd_grant_lock);
 755 }
 756
 757 /**
 758  * Called at prepare time when handling read request. This function extracts
 759  * incoming grant information from the obdo and processes the grant shrink
 760  * request, if any.
 761  *
 762  * \param env - is the lu environment provided by the caller
 763  * \param exp - is the export of the client which sent the request
 764  * \paral oa - is the incoming obdo sent by the client
 765  */
 766 void ofd_grant_prepare_read(const struct lu_env *env,
 767                             struct obd_export *exp, struct obdo *oa)
 768 {
 769         struct ofd_device       *ofd = ofd_exp(exp);
 770         int                      do_shrink;
 771         obd_size                 left = 0;
 772
 773         if (!oa)
 774                 return;
 775
 776         if ((oa->o_valid & OBD_MD_FLGRANT) == 0)
 777                 /* The read request does not contain any grant
 778                  * information */
 779                 return;
 780
 781         if ((oa->o_valid & OBD_MD_FLFLAGS) &&
 782             (oa->o_flags & OBD_FL_SHRINK_GRANT)) {
 783                 /* To process grant shrink request, we need to know how much
 784                  * available space remains on the backend filesystem.
 785                  * Shrink requests are not so common, we always get fresh
 786                  * statfs information. */
 787                 ofd_grant_statfs(env, exp, 1, NULL);
 788
 789                 /* protect all grant counters */
 790                 spin_lock(&ofd->ofd_grant_lock);
 791
 792                 /* Grab free space from cached statfs data and take out space
 793                  * already granted to clients as well as reserved space */
 794                 left = ofd_grant_space_left(exp);
 795
 796                 /* all set now to proceed with shrinking */
 797                 do_shrink = 1;
 798         } else {
 799                 /* no grant shrinking request packed in the obdo and
 800                  * since we don't grant space back on reads, no point
 801                  * in running statfs, so just skip it and process
 802                  * incoming grant data directly. */
 803                 spin_lock(&ofd->ofd_grant_lock);
 804                 do_shrink = 0;
 805         }
 806
 807         /* extract incoming grant infomation provided by the client */
 808         ofd_grant_incoming(env, exp, oa);
 809
 810         /* unlike writes, we don't return grants back on reads unless a grant
 811          * shrink request was packed and we decided to turn it down. */
 812         if (do_shrink)
 813                 ofd_grant_shrink(exp, oa, left);
 814         else
 815                 oa->o_grant = 0;
 816
 817         spin_unlock(&ofd->ofd_grant_lock);
 818 }
 819
 820 /**
 821  * Called at write prepare time to handle incoming grant, check that we have
 822  * enough space and grant some space back to the client if possible.
 823  *
 824  * \param env - is the lu environment provided by the caller
 825  * \param exp - is the export of the client which sent the request
 826  * \paral oa - is the incoming obdo sent by the client
 827  * \param rnb - is the list of network buffers
 828  * \param niocont - is the number of network buffers in the list
 829  */
 830 void ofd_grant_prepare_write(const struct lu_env *env,
 831                              struct obd_export *exp, struct obdo *oa,
 832                              struct niobuf_remote *rnb, int niocount)
 833 {
 834         struct obd_device       *obd = exp->exp_obd;
 835         struct ofd_device       *ofd = ofd_exp(exp);
 836         obd_size                 left;
 837         int                      from_cache;
 838         int                      force = 0; /* can use cached data intially */
 839         int                      rc;
 840
 841         ENTRY;
 842
 843 refresh:
 844         /* get statfs information from OSD layer */
 845         ofd_grant_statfs(env, exp, force, &from_cache);
 846
 847         spin_lock(&ofd->ofd_grant_lock); /* protect all grant counters */
 848
 849         /* Grab free space from cached statfs data and take out space already
 850          * granted to clients as well as reserved space */
 851         left = ofd_grant_space_left(exp);
 852
 853         /* Get fresh statfs data if we are short in ungranted space */
 854         if (from_cache && left < 32 * ofd_grant_chunk(exp, ofd)) {
 855                 spin_unlock(&ofd->ofd_grant_lock);
 856                 CDEBUG(D_CACHE, "%s: fs has no space left and statfs too old\n",
 857                        obd->obd_name);
 858                 force = 1;
 859                 goto refresh;
 860         }
 861
 862         /* When close to free space exhaustion, trigger a sync to force
 863          * writeback cache to consume required space immediately and release as
 864          * much space as possible. */
 865         if (!obd->obd_recovering && force != 2 && left < OFD_GRANT_CHUNK) {
 866                 bool from_grant = true;
 867                 int  i;
 868
 869                 /* That said, it is worth running a sync only if some pages did
 870                  * not consume grant space on the client and could thus fail
 871                  * with ENOSPC later in ofd_grant_check() */
 872                 for (i = 0; i < niocount; i++)
 873                         if (!(rnb[i].rnb_flags & OBD_BRW_FROM_GRANT))
 874                                 from_grant = false;
 875
 876                 if (!from_grant) {
 877                         /* at least one network buffer requires acquiring grant
 878                          * space on the server */
 879                         spin_unlock(&ofd->ofd_grant_lock);
 880                         /* discard errors, at least we tried ... */
 881                         rc = dt_sync(env, ofd->ofd_osd);
 882                         force = 2;
 883                         goto refresh;
 884                 }
 885         }
 886
 887         /* extract incoming grant information provided by the client */
 888         ofd_grant_incoming(env, exp, oa);
 889
 890         /* check limit */
 891         ofd_grant_check(env, exp, oa, rnb, niocount, &left);
 892
 893         if (!(oa->o_valid & OBD_MD_FLGRANT)) {
 894                 spin_unlock(&ofd->ofd_grant_lock);
 895                 RETURN_EXIT;
 896         }
 897
 898         /* if OBD_FL_SHRINK_GRANT is set, the client is willing to release some
 899          * grant space. */
 900         if ((oa->o_valid & OBD_MD_FLFLAGS) &&
 901             (oa->o_flags & OBD_FL_SHRINK_GRANT))
 902                 ofd_grant_shrink(exp, oa, left);
 903         else
 904                 /* grant more space back to the client if possible */
 905                 oa->o_grant = ofd_grant(exp, oa->o_grant, oa->o_undirty, left);
 906         spin_unlock(&ofd->ofd_grant_lock);
 907 }
 908
 909 /**
 910  * Called during object precreation to consume grant space.
 911  * More space is granted for precreation if possible.
 912  *
 913  * \param env - is the lu environment provided by the caller
 914  * \param exp - is the export holding the grant space for precreation (= self
 915  *            export currently)
 916  * \paral nr - is the number of objects the caller wants to create objects
 917  */
 918 int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr)
 919 {
 920         struct ofd_thread_info          *info = ofd_info(env);
 921         struct ofd_device               *ofd = ofd_exp(exp);
 922         struct filter_export_data       *fed = &exp->exp_filter_data;
 923         obd_size                         left = 0;
 924         unsigned long                    wanted;
 925
 926         ENTRY;
 927
 928         info->fti_used = 0;
 929
 930         if (exp->exp_obd->obd_recovering ||
 931             ofd->ofd_dt_conf.ddp_inodespace == 0)
 932                 /* don't enforce grant during recovery */
 933                 RETURN(0);
 934
 935         /* Update statfs data if required */
 936         ofd_grant_statfs(env, exp, 1, NULL);
 937
 938         /* protect all grant counters */
 939         spin_lock(&ofd->ofd_grant_lock);
 940
 941         /* fail precreate request if there is not enough blocks available for
 942          * writing */
 943         if (ofd->ofd_osfs.os_bavail - (fed->fed_grant >> ofd->ofd_blockbits) <
 944             (ofd->ofd_osfs.os_blocks >> 10)) {
 945                 spin_unlock(&ofd->ofd_grant_lock);
 946                 CDEBUG(D_RPCTRACE, "%s: not enough space for create "LPU64"\n",
 947                        ofd_obd(ofd)->obd_name,
 948                        ofd->ofd_osfs.os_bavail * ofd->ofd_osfs.os_blocks);
 949                 RETURN(-ENOSPC);
 950         }
 951
 952         /* Grab free space from cached statfs data and take out space
 953          * already granted to clients as well as reserved space */
 954         left = ofd_grant_space_left(exp);
 955
 956         /* compute how much space is required to handle the precreation
 957          * request */
 958         wanted = *nr * ofd->ofd_dt_conf.ddp_inodespace;
 959         if (wanted > fed->fed_grant + left) {
 960                 /* that's beyond what remains, adjust the number of objects that
 961                  * can be safely precreated */
 962                 wanted = fed->fed_grant + left;
 963                 *nr = wanted / ofd->ofd_dt_conf.ddp_inodespace;
 964                 if (*nr == 0) {
 965                         /* we really have no space any more for precreation,
 966                          * fail the precreate request with ENOSPC */
 967                         spin_unlock(&ofd->ofd_grant_lock);
 968                         RETURN(-ENOSPC);
 969                 }
 970                 /* compute space needed for the new number of creations */
 971                 wanted = *nr * ofd->ofd_dt_conf.ddp_inodespace;
 972         }
 973         LASSERT(wanted <= fed->fed_grant + left);
 974
 975         if (wanted <= fed->fed_grant) {
 976                 /* we've enough grant space to handle this precreate request */
 977                 fed->fed_grant -= wanted;
 978         } else {
 979                 /* we need to take some space from the ungranted pool */
 980                 ofd->ofd_tot_granted += wanted - fed->fed_grant;
 981                 left -= wanted - fed->fed_grant;
 982                 fed->fed_grant = 0;
 983         }
 984         info->fti_used = wanted;
 985         fed->fed_pending += info->fti_used;
 986         ofd->ofd_tot_pending += info->fti_used;
 987
 988         /* grant more space (twice as much as needed for this request) for
 989          * precreate purpose if possible */
 990         ofd_grant(exp, fed->fed_grant, wanted * 2, left);
 991         spin_unlock(&ofd->ofd_grant_lock);
 992         RETURN(0);
 993 }
 994
 995 /**
 996  * Called at commit time to update pending grant counter for writes in flight
 997  *
 998  * \param env - is the lu environment provided by the caller
 999  * \param exp - is the export of the client which sent the request
1000  */
1001 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
1002                       int rc)
1003 {
1004         struct ofd_device       *ofd  = ofd_exp(exp);
1005         struct ofd_thread_info  *info = ofd_info(env);
1006         unsigned long            pending;
1007
1008         ENTRY;
1009
1010         /* get space accounted in tot_pending for the I/O, set in
1011          * ofd_grant_check() */
1012         pending = info->fti_used;
1013         if (pending == 0)
1014                 RETURN_EXIT;
1015
1016         spin_lock(&ofd->ofd_grant_lock);
1017         /* Don't update statfs data for errors raised before commit (e.g.
1018          * bulk transfer failed, ...) since we know those writes have not been
1019          * processed. For other errors hit during commit, we cannot really tell
1020          * whether or not something was written, so we update statfs data.
1021          * In any case, this should not be fatal since we always get fresh
1022          * statfs data before failing a request with ENOSPC */
1023         if (rc == 0) {
1024                 spin_lock(&ofd->ofd_osfs_lock);
1025                 /* Take pending out of cached statfs data */
1026                 ofd->ofd_osfs.os_bavail -= min_t(obd_size,
1027                                                  ofd->ofd_osfs.os_bavail,
1028                                                  pending >> ofd->ofd_blockbits);
1029                 if (ofd->ofd_statfs_inflight)
1030                         /* someone is running statfs and want to be notified of
1031                          * writes happening meanwhile */
1032                         ofd->ofd_osfs_inflight += pending;
1033                 spin_unlock(&ofd->ofd_osfs_lock);
1034         }
1035
1036         if (exp->exp_filter_data.fed_pending < pending) {
1037                 CERROR("%s: cli %s/%p fed_pending(%lu) < grant_used(%lu)\n",
1038                        exp->exp_obd->obd_name, exp->exp_client_uuid.uuid, exp,
1039                        exp->exp_filter_data.fed_pending, pending);
1040                 spin_unlock(&ofd->ofd_grant_lock);
1041                 LBUG();
1042         }
1043         exp->exp_filter_data.fed_pending -= pending;
1044
1045         if (ofd->ofd_tot_granted < pending) {
1046                  CERROR("%s: cli %s/%p tot_granted("LPU64") < grant_used(%lu)"
1047                         "\n", exp->exp_obd->obd_name,
1048                         exp->exp_client_uuid.uuid, exp, ofd->ofd_tot_granted,
1049                         pending);
1050                 spin_unlock(&ofd->ofd_grant_lock);
1051                 LBUG();
1052         }
1053         ofd->ofd_tot_granted -= pending;
1054
1055         if (ofd->ofd_tot_pending < pending) {
1056                  CERROR("%s: cli %s/%p tot_pending("LPU64") < grant_used(%lu)"
1057                         "\n", exp->exp_obd->obd_name, exp->exp_client_uuid.uuid,
1058                         exp, ofd->ofd_tot_pending, pending);
1059                 spin_unlock(&ofd->ofd_grant_lock);
1060                 LBUG();
1061         }
1062         ofd->ofd_tot_pending -= pending;
1063         spin_unlock(&ofd->ofd_grant_lock);
1064         EXIT;
1065 }