fs/ceph/quota.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * quota.c - CephFS quota
   4  *
   5  * Copyright (C) 2017-2018 SUSE
   6  */
   7
   8 #include <linux/statfs.h>
   9
  10 #include "super.h"
  11 #include "mds_client.h"
  12
  13 void ceph_adjust_quota_realms_count(struct inode *inode, bool inc)
  14 {
  15         struct ceph_mds_client *mdsc = ceph_sb_to_mdsc(inode->i_sb);
  16         if (inc)
  17                 atomic64_inc(&mdsc->quotarealms_count);
  18         else
  19                 atomic64_dec(&mdsc->quotarealms_count);
  20 }
  21
  22 static inline bool ceph_has_realms_with_quotas(struct inode *inode)
  23 {
  24         struct super_block *sb = inode->i_sb;
  25         struct ceph_mds_client *mdsc = ceph_sb_to_mdsc(sb);
  26         struct inode *root = d_inode(sb->s_root);
  27
  28         if (atomic64_read(&mdsc->quotarealms_count) > 0)
  29                 return true;
  30         /* if root is the real CephFS root, we don't have quota realms */
  31         if (root && ceph_ino(root) == CEPH_INO_ROOT)
  32                 return false;
  33         /* MDS stray dirs have no quota realms */
  34         if (ceph_vino_is_reserved(ceph_inode(inode)->i_vino))
  35                 return false;
  36         /* otherwise, we can't know for sure */
  37         return true;
  38 }
  39
  40 void ceph_handle_quota(struct ceph_mds_client *mdsc,
  41                        struct ceph_mds_session *session,
  42                        struct ceph_msg *msg)
  43 {
  44         struct super_block *sb = mdsc->fsc->sb;
  45         struct ceph_mds_quota *h = msg->front.iov_base;
  46         struct ceph_client *cl = mdsc->fsc->client;
  47         struct ceph_vino vino;
  48         struct inode *inode;
  49         struct ceph_inode_info *ci;
  50
  51         if (!ceph_inc_mds_stopping_blocker(mdsc, session))
  52                 return;
  53
  54         if (msg->front.iov_len < sizeof(*h)) {
  55                 pr_err_client(cl, "corrupt message mds%d len %d\n",
  56                               session->s_mds, (int)msg->front.iov_len);
  57                 ceph_msg_dump(msg);
  58                 goto out;
  59         }
  60
  61         /* lookup inode */
  62         vino.ino = le64_to_cpu(h->ino);
  63         vino.snap = CEPH_NOSNAP;
  64         inode = ceph_find_inode(sb, vino);
  65         if (!inode) {
  66                 pr_warn_client(cl, "failed to find inode %llx\n", vino.ino);
  67                 goto out;
  68         }
  69         ci = ceph_inode(inode);
  70
  71         spin_lock(&ci->i_ceph_lock);
  72         ci->i_rbytes = le64_to_cpu(h->rbytes);
  73         ci->i_rfiles = le64_to_cpu(h->rfiles);
  74         ci->i_rsubdirs = le64_to_cpu(h->rsubdirs);
  75         __ceph_update_quota(ci, le64_to_cpu(h->max_bytes),
  76                             le64_to_cpu(h->max_files));
  77         spin_unlock(&ci->i_ceph_lock);
  78
  79         iput(inode);
  80 out:
  81         ceph_dec_mds_stopping_blocker(mdsc);
  82 }
  83
  84 static struct ceph_quotarealm_inode *
  85 find_quotarealm_inode(struct ceph_mds_client *mdsc, u64 ino)
  86 {
  87         struct ceph_quotarealm_inode *qri = NULL;
  88         struct rb_node **node, *parent = NULL;
  89         struct ceph_client *cl = mdsc->fsc->client;
  90
  91         mutex_lock(&mdsc->quotarealms_inodes_mutex);
  92         node = &(mdsc->quotarealms_inodes.rb_node);
  93         while (*node) {
  94                 parent = *node;
  95                 qri = container_of(*node, struct ceph_quotarealm_inode, node);
  96
  97                 if (ino < qri->ino)
  98                         node = &((*node)->rb_left);
  99                 else if (ino > qri->ino)
 100                         node = &((*node)->rb_right);
 101                 else
 102                         break;
 103         }
 104         if (!qri || (qri->ino != ino)) {
 105                 /* Not found, create a new one and insert it */
 106                 qri = kmalloc(sizeof(*qri), GFP_KERNEL);
 107                 if (qri) {
 108                         qri->ino = ino;
 109                         qri->inode = NULL;
 110                         qri->timeout = 0;
 111                         mutex_init(&qri->mutex);
 112                         rb_link_node(&qri->node, parent, node);
 113                         rb_insert_color(&qri->node, &mdsc->quotarealms_inodes);
 114                 } else
 115                         pr_warn_client(cl, "Failed to alloc quotarealms_inode\n");
 116         }
 117         mutex_unlock(&mdsc->quotarealms_inodes_mutex);
 118
 119         return qri;
 120 }
 121
 122 /*
 123  * This function will try to lookup a realm inode which isn't visible in the
 124  * filesystem mountpoint.  A list of these kind of inodes (not visible) is
 125  * maintained in the mdsc and freed only when the filesystem is umounted.
 126  *
 127  * Note that these inodes are kept in this list even if the lookup fails, which
 128  * allows to prevent useless lookup requests.
 129  */
 130 static struct inode *lookup_quotarealm_inode(struct ceph_mds_client *mdsc,
 131                                              struct super_block *sb,
 132                                              struct ceph_snap_realm *realm)
 133 {
 134         struct ceph_client *cl = mdsc->fsc->client;
 135         struct ceph_quotarealm_inode *qri;
 136         struct inode *in;
 137
 138         qri = find_quotarealm_inode(mdsc, realm->ino);
 139         if (!qri)
 140                 return NULL;
 141
 142         mutex_lock(&qri->mutex);
 143         if (qri->inode && ceph_is_any_caps(qri->inode)) {
 144                 /* A request has already returned the inode */
 145                 mutex_unlock(&qri->mutex);
 146                 return qri->inode;
 147         }
 148         /* Check if this inode lookup has failed recently */
 149         if (qri->timeout &&
 150             time_before_eq(jiffies, qri->timeout)) {
 151                 mutex_unlock(&qri->mutex);
 152                 return NULL;
 153         }
 154         if (qri->inode) {
 155                 /* get caps */
 156                 int ret = __ceph_do_getattr(qri->inode, NULL,
 157                                             CEPH_STAT_CAP_INODE, true);
 158                 if (ret >= 0)
 159                         in = qri->inode;
 160                 else
 161                         in = ERR_PTR(ret);
 162         }  else {
 163                 in = ceph_lookup_inode(sb, realm->ino);
 164         }
 165
 166         if (IS_ERR(in)) {
 167                 doutc(cl, "Can't lookup inode %llx (err: %ld)\n", realm->ino,
 168                       PTR_ERR(in));
 169                 qri->timeout = jiffies + msecs_to_jiffies(60 * 1000); /* XXX */
 170         } else {
 171                 qri->timeout = 0;
 172                 qri->inode = in;
 173         }
 174         mutex_unlock(&qri->mutex);
 175
 176         return in;
 177 }
 178
 179 void ceph_cleanup_quotarealms_inodes(struct ceph_mds_client *mdsc)
 180 {
 181         struct ceph_quotarealm_inode *qri;
 182         struct rb_node *node;
 183
 184         /*
 185          * It should now be safe to clean quotarealms_inode tree without holding
 186          * mdsc->quotarealms_inodes_mutex...
 187          */
 188         mutex_lock(&mdsc->quotarealms_inodes_mutex);
 189         while (!RB_EMPTY_ROOT(&mdsc->quotarealms_inodes)) {
 190                 node = rb_first(&mdsc->quotarealms_inodes);
 191                 qri = rb_entry(node, struct ceph_quotarealm_inode, node);
 192                 rb_erase(node, &mdsc->quotarealms_inodes);
 193                 iput(qri->inode);
 194                 kfree(qri);
 195         }
 196         mutex_unlock(&mdsc->quotarealms_inodes_mutex);
 197 }
 198
 199 /*
 200  * This function walks through the snaprealm for an inode and returns the
 201  * ceph_snap_realm for the first snaprealm that has quotas set (max_files,
 202  * max_bytes, or any, depending on the 'which_quota' argument).  If the root is
 203  * reached, return the root ceph_snap_realm instead.
 204  *
 205  * Note that the caller is responsible for calling ceph_put_snap_realm() on the
 206  * returned realm.
 207  *
 208  * Callers of this function need to hold mdsc->snap_rwsem.  However, if there's
 209  * a need to do an inode lookup, this rwsem will be temporarily dropped.  Hence
 210  * the 'retry' argument: if rwsem needs to be dropped and 'retry' is 'false'
 211  * this function will return -EAGAIN; otherwise, the snaprealms walk-through
 212  * will be restarted.
 213  */
 214 static struct ceph_snap_realm *get_quota_realm(struct ceph_mds_client *mdsc,
 215                                                struct inode *inode,
 216                                                enum quota_get_realm which_quota,
 217                                                bool retry)
 218 {
 219         struct ceph_client *cl = mdsc->fsc->client;
 220         struct ceph_inode_info *ci = NULL;
 221         struct ceph_snap_realm *realm, *next;
 222         struct inode *in;
 223         bool has_quota;
 224
 225         if (ceph_snap(inode) != CEPH_NOSNAP)
 226                 return NULL;
 227
 228 restart:
 229         realm = ceph_inode(inode)->i_snap_realm;
 230         if (realm)
 231                 ceph_get_snap_realm(mdsc, realm);
 232         else
 233                 pr_err_ratelimited_client(cl,
 234                                 "%p %llx.%llx null i_snap_realm\n",
 235                                 inode, ceph_vinop(inode));
 236         while (realm) {
 237                 bool has_inode;
 238
 239                 spin_lock(&realm->inodes_with_caps_lock);
 240                 has_inode = realm->inode;
 241                 in = has_inode ? igrab(realm->inode) : NULL;
 242                 spin_unlock(&realm->inodes_with_caps_lock);
 243                 if (has_inode && !in)
 244                         break;
 245                 if (!in) {
 246                         up_read(&mdsc->snap_rwsem);
 247                         in = lookup_quotarealm_inode(mdsc, inode->i_sb, realm);
 248                         down_read(&mdsc->snap_rwsem);
 249                         if (IS_ERR_OR_NULL(in))
 250                                 break;
 251                         ceph_put_snap_realm(mdsc, realm);
 252                         if (!retry)
 253                                 return ERR_PTR(-EAGAIN);
 254                         goto restart;
 255                 }
 256
 257                 ci = ceph_inode(in);
 258                 has_quota = __ceph_has_quota(ci, which_quota);
 259                 iput(in);
 260
 261                 next = realm->parent;
 262                 if (has_quota || !next)
 263                        return realm;
 264
 265                 ceph_get_snap_realm(mdsc, next);
 266                 ceph_put_snap_realm(mdsc, realm);
 267                 realm = next;
 268         }
 269         if (realm)
 270                 ceph_put_snap_realm(mdsc, realm);
 271
 272         return NULL;
 273 }
 274
 275 bool ceph_quota_is_same_realm(struct inode *old, struct inode *new)
 276 {
 277         struct ceph_mds_client *mdsc = ceph_sb_to_mdsc(old->i_sb);
 278         struct ceph_snap_realm *old_realm, *new_realm;
 279         bool is_same;
 280
 281 restart:
 282         /*
 283          * We need to lookup 2 quota realms atomically, i.e. with snap_rwsem.
 284          * However, get_quota_realm may drop it temporarily.  By setting the
 285          * 'retry' parameter to 'false', we'll get -EAGAIN if the rwsem was
 286          * dropped and we can then restart the whole operation.
 287          */
 288         down_read(&mdsc->snap_rwsem);
 289         old_realm = get_quota_realm(mdsc, old, QUOTA_GET_ANY, true);
 290         new_realm = get_quota_realm(mdsc, new, QUOTA_GET_ANY, false);
 291         if (PTR_ERR(new_realm) == -EAGAIN) {
 292                 up_read(&mdsc->snap_rwsem);
 293                 if (old_realm)
 294                         ceph_put_snap_realm(mdsc, old_realm);
 295                 goto restart;
 296         }
 297         is_same = (old_realm == new_realm);
 298         up_read(&mdsc->snap_rwsem);
 299
 300         if (old_realm)
 301                 ceph_put_snap_realm(mdsc, old_realm);
 302         if (new_realm)
 303                 ceph_put_snap_realm(mdsc, new_realm);
 304
 305         return is_same;
 306 }
 307
 308 enum quota_check_op {
 309         QUOTA_CHECK_MAX_FILES_OP,       /* check quota max_files limit */
 310         QUOTA_CHECK_MAX_BYTES_OP,       /* check quota max_files limit */
 311         QUOTA_CHECK_MAX_BYTES_APPROACHING_OP    /* check if quota max_files
 312                                                    limit is approaching */
 313 };
 314
 315 /*
 316  * check_quota_exceeded() will walk up the snaprealm hierarchy and, for each
 317  * realm, it will execute quota check operation defined by the 'op' parameter.
 318  * The snaprealm walk is interrupted if the quota check detects that the quota
 319  * is exceeded or if the root inode is reached.
 320  */
 321 static bool check_quota_exceeded(struct inode *inode, enum quota_check_op op,
 322                                  loff_t delta)
 323 {
 324         struct ceph_mds_client *mdsc = ceph_sb_to_mdsc(inode->i_sb);
 325         struct ceph_client *cl = mdsc->fsc->client;
 326         struct ceph_inode_info *ci;
 327         struct ceph_snap_realm *realm, *next;
 328         struct inode *in;
 329         u64 max, rvalue;
 330         bool exceeded = false;
 331
 332         if (ceph_snap(inode) != CEPH_NOSNAP)
 333                 return false;
 334
 335         down_read(&mdsc->snap_rwsem);
 336 restart:
 337         realm = ceph_inode(inode)->i_snap_realm;
 338         if (realm)
 339                 ceph_get_snap_realm(mdsc, realm);
 340         else
 341                 pr_err_ratelimited_client(cl,
 342                                 "%p %llx.%llx null i_snap_realm\n",
 343                                 inode, ceph_vinop(inode));
 344         while (realm) {
 345                 bool has_inode;
 346
 347                 spin_lock(&realm->inodes_with_caps_lock);
 348                 has_inode = realm->inode;
 349                 in = has_inode ? igrab(realm->inode) : NULL;
 350                 spin_unlock(&realm->inodes_with_caps_lock);
 351                 if (has_inode && !in)
 352                         break;
 353                 if (!in) {
 354                         up_read(&mdsc->snap_rwsem);
 355                         in = lookup_quotarealm_inode(mdsc, inode->i_sb, realm);
 356                         down_read(&mdsc->snap_rwsem);
 357                         if (IS_ERR_OR_NULL(in))
 358                                 break;
 359                         ceph_put_snap_realm(mdsc, realm);
 360                         goto restart;
 361                 }
 362                 ci = ceph_inode(in);
 363                 spin_lock(&ci->i_ceph_lock);
 364                 if (op == QUOTA_CHECK_MAX_FILES_OP) {
 365                         max = ci->i_max_files;
 366                         rvalue = ci->i_rfiles + ci->i_rsubdirs;
 367                 } else {
 368                         max = ci->i_max_bytes;
 369                         rvalue = ci->i_rbytes;
 370                 }
 371                 spin_unlock(&ci->i_ceph_lock);
 372                 switch (op) {
 373                 case QUOTA_CHECK_MAX_FILES_OP:
 374                 case QUOTA_CHECK_MAX_BYTES_OP:
 375                         exceeded = (max && (rvalue + delta > max));
 376                         break;
 377                 case QUOTA_CHECK_MAX_BYTES_APPROACHING_OP:
 378                         if (max) {
 379                                 if (rvalue >= max)
 380                                         exceeded = true;
 381                                 else {
 382                                         /*
 383                                          * when we're writing more that 1/16th
 384                                          * of the available space
 385                                          */
 386                                         exceeded =
 387                                                 (((max - rvalue) >> 4) < delta);
 388                                 }
 389                         }
 390                         break;
 391                 default:
 392                         /* Shouldn't happen */
 393                         pr_warn_client(cl, "Invalid quota check op (%d)\n", op);
 394                         exceeded = true; /* Just break the loop */
 395                 }
 396                 iput(in);
 397
 398                 next = realm->parent;
 399                 if (exceeded || !next)
 400                         break;
 401                 ceph_get_snap_realm(mdsc, next);
 402                 ceph_put_snap_realm(mdsc, realm);
 403                 realm = next;
 404         }
 405         if (realm)
 406                 ceph_put_snap_realm(mdsc, realm);
 407         up_read(&mdsc->snap_rwsem);
 408
 409         return exceeded;
 410 }
 411
 412 /*
 413  * ceph_quota_is_max_files_exceeded - check if we can create a new file
 414  * @inode:      directory where a new file is being created
 415  *
 416  * This functions returns true is max_files quota allows a new file to be
 417  * created.  It is necessary to walk through the snaprealm hierarchy (until the
 418  * FS root) to check all realms with quotas set.
 419  */
 420 bool ceph_quota_is_max_files_exceeded(struct inode *inode)
 421 {
 422         if (!ceph_has_realms_with_quotas(inode))
 423                 return false;
 424
 425         WARN_ON(!S_ISDIR(inode->i_mode));
 426
 427         return check_quota_exceeded(inode, QUOTA_CHECK_MAX_FILES_OP, 1);
 428 }
 429
 430 /*
 431  * ceph_quota_is_max_bytes_exceeded - check if we can write to a file
 432  * @inode:      inode being written
 433  * @newsize:    new size if write succeeds
 434  *
 435  * This functions returns true is max_bytes quota allows a file size to reach
 436  * @newsize; it returns false otherwise.
 437  */
 438 bool ceph_quota_is_max_bytes_exceeded(struct inode *inode, loff_t newsize)
 439 {
 440         loff_t size = i_size_read(inode);
 441
 442         if (!ceph_has_realms_with_quotas(inode))
 443                 return false;
 444
 445         /* return immediately if we're decreasing file size */
 446         if (newsize <= size)
 447                 return false;
 448
 449         return check_quota_exceeded(inode, QUOTA_CHECK_MAX_BYTES_OP, (newsize - size));
 450 }
 451
 452 /*
 453  * ceph_quota_is_max_bytes_approaching - check if we're reaching max_bytes
 454  * @inode:      inode being written
 455  * @newsize:    new size if write succeeds
 456  *
 457  * This function returns true if the new file size @newsize will be consuming
 458  * more than 1/16th of the available quota space; it returns false otherwise.
 459  */
 460 bool ceph_quota_is_max_bytes_approaching(struct inode *inode, loff_t newsize)
 461 {
 462         loff_t size = ceph_inode(inode)->i_reported_size;
 463
 464         if (!ceph_has_realms_with_quotas(inode))
 465                 return false;
 466
 467         /* return immediately if we're decreasing file size */
 468         if (newsize <= size)
 469                 return false;
 470
 471         return check_quota_exceeded(inode, QUOTA_CHECK_MAX_BYTES_APPROACHING_OP,
 472                                     (newsize - size));
 473 }
 474
 475 /*
 476  * ceph_quota_update_statfs - if root has quota update statfs with quota status
 477  * @fsc:        filesystem client instance
 478  * @buf:        statfs to update
 479  *
 480  * If the mounted filesystem root has max_bytes quota set, update the filesystem
 481  * statistics with the quota status.
 482  *
 483  * This function returns true if the stats have been updated, false otherwise.
 484  */
 485 bool ceph_quota_update_statfs(struct ceph_fs_client *fsc, struct kstatfs *buf)
 486 {
 487         struct ceph_mds_client *mdsc = fsc->mdsc;
 488         struct ceph_inode_info *ci;
 489         struct ceph_snap_realm *realm;
 490         struct inode *in;
 491         u64 total = 0, used, free;
 492         bool is_updated = false;
 493
 494         down_read(&mdsc->snap_rwsem);
 495         realm = get_quota_realm(mdsc, d_inode(fsc->sb->s_root),
 496                                 QUOTA_GET_MAX_BYTES, true);
 497         up_read(&mdsc->snap_rwsem);
 498         if (!realm)
 499                 return false;
 500
 501         spin_lock(&realm->inodes_with_caps_lock);
 502         in = realm->inode ? igrab(realm->inode) : NULL;
 503         spin_unlock(&realm->inodes_with_caps_lock);
 504         if (in) {
 505                 ci = ceph_inode(in);
 506                 spin_lock(&ci->i_ceph_lock);
 507                 if (ci->i_max_bytes) {
 508                         total = ci->i_max_bytes >> CEPH_BLOCK_SHIFT;
 509                         used = ci->i_rbytes >> CEPH_BLOCK_SHIFT;
 510                         /* For quota size less than 4MB, use 4KB block size */
 511                         if (!total) {
 512                                 total = ci->i_max_bytes >> CEPH_4K_BLOCK_SHIFT;
 513                                 used = ci->i_rbytes >> CEPH_4K_BLOCK_SHIFT;
 514                                 buf->f_frsize = 1 << CEPH_4K_BLOCK_SHIFT;
 515                         }
 516                         /* It is possible for a quota to be exceeded.
 517                          * Report 'zero' in that case
 518                          */
 519                         free = total > used ? total - used : 0;
 520                         /* For quota size less than 4KB, report the
 521                          * total=used=4KB,free=0 when quota is full
 522                          * and total=free=4KB, used=0 otherwise */
 523                         if (!total) {
 524                                 total = 1;
 525                                 free = ci->i_max_bytes > ci->i_rbytes ? 1 : 0;
 526                                 buf->f_frsize = 1 << CEPH_4K_BLOCK_SHIFT;
 527                         }
 528                 }
 529                 spin_unlock(&ci->i_ceph_lock);
 530                 if (total) {
 531                         buf->f_blocks = total;
 532                         buf->f_bfree = free;
 533                         buf->f_bavail = free;
 534                         is_updated = true;
 535                 }
 536                 iput(in);
 537         }
 538         ceph_put_snap_realm(mdsc, realm);
 539
 540         return is_updated;
 541 }
 542