lustre/osd-ldiskfs/osd_quota.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, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 021110-1307, USA
  20  *
  21  * GPL HEADER END
  22  */
  23 /*
  24  * Copyright (c) 2012, 2013, Intel Corporation.
  25  * Use is subject to license terms.
  26  *
  27  * Author: Johann Lombardi <johann@whamcloud.com>
  28  * Author: Niu    Yawei    <niu@whamcloud.com>
  29  */
  30
  31 #include <lustre_quota.h>
  32 #include "osd_internal.h"
  33
  34 /**
  35  * Helpers function to find out the quota type (USRQUOTA/GRPQUOTA) of a
  36  * given object
  37  */
  38 static inline int fid2type(const struct lu_fid *fid)
  39 {
  40         LASSERT(fid_is_acct(fid));
  41         if (fid_oid(fid) == ACCT_GROUP_OID)
  42                 return GRPQUOTA;
  43         return USRQUOTA;
  44 }
  45
  46 static inline int obj2type(struct dt_object *obj)
  47 {
  48         return fid2type(lu_object_fid(&obj->do_lu));
  49 }
  50
  51 /**
  52  * Space Accounting Management
  53  */
  54
  55 /**
  56  * Look up an accounting object based on its fid.
  57  *
  58  * \param info - is the osd thread info passed by the caller
  59  * \param osd  - is the osd device
  60  * \param fid  - is the fid of the accounting object we want to look up
  61  * \param id   - is the osd_inode_id struct to fill with the inode number of
  62  *               the quota file if the lookup is successful
  63  */
  64 int osd_acct_obj_lookup(struct osd_thread_info *info, struct osd_device *osd,
  65                         const struct lu_fid *fid, struct osd_inode_id *id)
  66 {
  67         struct super_block *sb = osd_sb(osd);
  68         unsigned long qf_inums[2] = {
  69                 le32_to_cpu(LDISKFS_SB(sb)->s_es->s_usr_quota_inum),
  70                 le32_to_cpu(LDISKFS_SB(sb)->s_es->s_grp_quota_inum)
  71         };
  72
  73         ENTRY;
  74         LASSERT(fid_is_acct(fid));
  75
  76         if (!LDISKFS_HAS_RO_COMPAT_FEATURE(sb,
  77                                            LDISKFS_FEATURE_RO_COMPAT_QUOTA))
  78                 RETURN(-ENOENT);
  79
  80         id->oii_gen = OSD_OII_NOGEN;
  81         id->oii_ino = qf_inums[fid2type(fid)];
  82         if (!ldiskfs_valid_inum(sb, id->oii_ino))
  83                 RETURN(-ENOENT);
  84         RETURN(0);
  85 }
  86
  87 /**
  88  * Return space usage (#blocks & #inodes) consumed by a given uid or gid.
  89  *
  90  * \param env   - is the environment passed by the caller
  91  * \param dtobj - is the accounting object
  92  * \param dtrec - is the record to fill with space usage information
  93  * \param dtkey - is the id the of the user or group for which we would
  94  *                like to access disk usage.
  95  * \param capa - is the capability, not used.
  96  *
  97  * \retval +ve - success : exact match
  98  * \retval -ve - failure
  99  */
 100 static int osd_acct_index_lookup(const struct lu_env *env,
 101                                  struct dt_object *dtobj,
 102                                  struct dt_rec *dtrec,
 103                                  const struct dt_key *dtkey,
 104                                  struct lustre_capa *capa)
 105 {
 106         struct osd_thread_info  *info = osd_oti_get(env);
 107 #ifdef HAVE_DQUOT_FS_DISK_QUOTA
 108         struct fs_disk_quota    *dqblk = &info->oti_fdq;
 109 #else
 110         struct if_dqblk         *dqblk = &info->oti_dqblk;
 111 #endif
 112         struct super_block      *sb = osd_sb(osd_obj2dev(osd_dt_obj(dtobj)));
 113         struct lquota_acct_rec  *rec = (struct lquota_acct_rec *)dtrec;
 114         __u64                    id = *((__u64 *)dtkey);
 115         int                      rc;
 116 #ifdef HAVE_DQUOT_KQID
 117         struct kqid             qid;
 118 #endif
 119
 120         ENTRY;
 121
 122         memset((void *)dqblk, 0, sizeof(struct obd_dqblk));
 123 #ifdef HAVE_DQUOT_KQID
 124         qid = make_kqid(&init_user_ns, obj2type(dtobj), id);
 125         rc = sb->s_qcop->get_dqblk(sb, qid, dqblk);
 126 #else
 127         rc = sb->s_qcop->get_dqblk(sb, obj2type(dtobj), (qid_t) id, dqblk);
 128 #endif
 129         if (rc)
 130                 RETURN(rc);
 131 #ifdef HAVE_DQUOT_FS_DISK_QUOTA
 132         rec->bspace = dqblk->d_bcount;
 133         rec->ispace = dqblk->d_icount;
 134 #else
 135         rec->bspace = dqblk->dqb_curspace;
 136         rec->ispace = dqblk->dqb_curinodes;
 137 #endif
 138         RETURN(+1);
 139 }
 140
 141 #define QUOTA_IT_READ_ERROR(it, rc)                                    \
 142         CERROR("%s: Error while trying to read quota information, "    \
 143                "failed with %d\n",                                     \
 144                osd_dev(it->oiq_obj->oo_dt.do_lu.lo_dev)->od_svname, rc); \
 145
 146 /**
 147  * Initialize osd Iterator for given osd index object.
 148  *
 149  * \param  dt    - osd index object
 150  * \param  attr  - not used
 151  * \param  capa  - BYPASS_CAPA
 152  */
 153 static struct dt_it *osd_it_acct_init(const struct lu_env *env,
 154                                       struct dt_object *dt,
 155                                       __u32 attr, struct lustre_capa *capa)
 156 {
 157         struct osd_thread_info  *info = osd_oti_get(env);
 158         struct osd_it_quota     *it;
 159         struct lu_object        *lo = &dt->do_lu;
 160         struct osd_object       *obj = osd_dt_obj(dt);
 161
 162         ENTRY;
 163
 164         LASSERT(lu_object_exists(lo));
 165
 166         if (info == NULL)
 167                 RETURN(ERR_PTR(-ENOMEM));
 168
 169         it = &info->oti_it_quota;
 170         memset(it, 0, sizeof(*it));
 171         lu_object_get(lo);
 172         it->oiq_obj = obj;
 173         INIT_LIST_HEAD(&it->oiq_list);
 174
 175         /* LUSTRE_DQTREEOFF is the initial offset where the tree can be found */
 176         it->oiq_blk[0] = LUSTRE_DQTREEOFF;
 177
 178         /* NB: we don't need to store the tree depth since it is always
 179          * equal to LUSTRE_DQTREEDEPTH - 1 (root has depth = 0) for a leaf
 180          * block. */
 181         RETURN((struct dt_it *)it);
 182 }
 183
 184 /**
 185  * Free given iterator.
 186  *
 187  * \param  di   - osd iterator
 188  */
 189 static void osd_it_acct_fini(const struct lu_env *env, struct dt_it *di)
 190 {
 191         struct osd_it_quota *it = (struct osd_it_quota *)di;
 192         struct osd_quota_leaf *leaf, *tmp;
 193         ENTRY;
 194
 195         lu_object_put(env, &it->oiq_obj->oo_dt.do_lu);
 196
 197         list_for_each_entry_safe(leaf, tmp, &it->oiq_list, oql_link) {
 198                 list_del_init(&leaf->oql_link);
 199                 OBD_FREE_PTR(leaf);
 200         }
 201         EXIT;
 202 }
 203
 204 /**
 205  * Move Iterator to record specified by \a key, if the \a key isn't found,
 206  * move to the first valid record.
 207  *
 208  * \param  di   - osd iterator
 209  * \param  key  - uid or gid
 210  *
 211  * \retval +ve  - di points to the first valid record
 212  * \retval  +1  - di points to exact matched key
 213  * \retval -ve  - failure
 214  */
 215 static int osd_it_acct_get(const struct lu_env *env, struct dt_it *di,
 216                            const struct dt_key *key)
 217 {
 218         struct osd_it_quota     *it = (struct osd_it_quota *)di;
 219         const struct lu_fid     *fid =
 220                                 lu_object_fid(&it->oiq_obj->oo_dt.do_lu);
 221         int                      type = fid2type(fid);
 222         qid_t                    dqid = *(qid_t *)key;
 223         loff_t                   offset;
 224         int                      rc;
 225
 226         ENTRY;
 227
 228         offset = find_tree_dqentry(env, it->oiq_obj, type, dqid,
 229                                    LUSTRE_DQTREEOFF, 0, it);
 230         if (offset > 0) { /* Found */
 231                 RETURN(+1);
 232         } else if (offset < 0) { /* Error */
 233                 QUOTA_IT_READ_ERROR(it, (int)offset);
 234                 RETURN((int)offset);
 235         }
 236
 237         /* The @key is not found, move to the first valid entry */
 238         rc = walk_tree_dqentry(env, it->oiq_obj, type, it->oiq_blk[0], 0,
 239                                0, it);
 240         if (rc == 0)
 241                 rc = 1;
 242         else if (rc > 0)
 243                 rc = -ENOENT;
 244
 245         RETURN(rc);
 246 }
 247
 248 /**
 249  * Release Iterator
 250  *
 251  * \param  di   - osd iterator
 252  */
 253 static void osd_it_acct_put(const struct lu_env *env, struct dt_it *di)
 254 {
 255         return;
 256 }
 257
 258 static int osd_it_add_processed(struct osd_it_quota *it, int depth)
 259 {
 260         struct osd_quota_leaf *leaf;
 261
 262         OBD_ALLOC_PTR(leaf);
 263         if (leaf == NULL)
 264                 RETURN(-ENOMEM);
 265         INIT_LIST_HEAD(&leaf->oql_link);
 266         leaf->oql_blk = it->oiq_blk[depth];
 267         list_add_tail(&leaf->oql_link, &it->oiq_list);
 268         RETURN(0);
 269 }
 270
 271 /**
 272  * Move on to the next valid entry.
 273  *
 274  * \param  di   - osd iterator
 275  *
 276  * \retval +ve  - iterator reached the end
 277  * \retval   0  - iterator has not reached the end yet
 278  * \retval -ve  - unexpected failure
 279  */
 280 static int osd_it_acct_next(const struct lu_env *env, struct dt_it *di)
 281 {
 282         struct osd_it_quota     *it = (struct osd_it_quota *)di;
 283         const struct lu_fid     *fid =
 284                                 lu_object_fid(&it->oiq_obj->oo_dt.do_lu);
 285         int                      type = fid2type(fid);
 286         int                      depth, rc;
 287         uint                     index;
 288
 289         ENTRY;
 290
 291         /* Let's first check if there are any remaining valid entry in the
 292          * current leaf block. Start with the next entry after the current one.
 293          */
 294         depth = LUSTRE_DQTREEDEPTH;
 295         index = it->oiq_index[depth];
 296         if (++index < LUSTRE_DQSTRINBLK) {
 297                 /* Search for the next valid entry from current index */
 298                 rc = walk_block_dqentry(env, it->oiq_obj, type,
 299                                         it->oiq_blk[depth], index, it);
 300                 if (rc < 0) {
 301                         QUOTA_IT_READ_ERROR(it, rc);
 302                         RETURN(rc);
 303                 } else if (rc == 0) {
 304                         /* Found on entry, @it is already updated to the
 305                          * new position in walk_block_dqentry(). */
 306                         RETURN(0);
 307                 } else {
 308                         rc = osd_it_add_processed(it, depth);
 309                         if (rc)
 310                                 RETURN(rc);
 311                 }
 312         } else {
 313                 rc = osd_it_add_processed(it, depth);
 314                 if (rc)
 315                         RETURN(rc);
 316         }
 317         rc = 1;
 318
 319         /* We have consumed all the entries of the current leaf block, move on
 320          * to the next one. */
 321         depth--;
 322
 323         /* We keep searching as long as walk_tree_dqentry() returns +1
 324          * (= no valid entry found). */
 325         for (; depth >= 0 && rc > 0; depth--) {
 326                 index = it->oiq_index[depth];
 327                 if (++index > 0xff)
 328                         continue;
 329                 rc = walk_tree_dqentry(env, it->oiq_obj, type,
 330                                        it->oiq_blk[depth], depth, index, it);
 331         }
 332
 333         if (rc < 0)
 334                 QUOTA_IT_READ_ERROR(it, rc);
 335         RETURN(rc);
 336 }
 337
 338 /**
 339  * Return pointer to the key under iterator.
 340  *
 341  * \param  di   - osd iterator
 342  */
 343 static struct dt_key *osd_it_acct_key(const struct lu_env *env,
 344                                       const struct dt_it *di)
 345 {
 346         struct osd_it_quota *it = (struct osd_it_quota *)di;
 347
 348         ENTRY;
 349         RETURN((struct dt_key *)&it->oiq_id);
 350 }
 351
 352 /**
 353  * Return size of key under iterator (in bytes)
 354  *
 355  * \param  di   - osd iterator
 356  */
 357 static int osd_it_acct_key_size(const struct lu_env *env,
 358                                 const struct dt_it *di)
 359 {
 360         struct osd_it_quota *it = (struct osd_it_quota *)di;
 361
 362         ENTRY;
 363         RETURN((int)sizeof(it->oiq_id));
 364 }
 365
 366 /**
 367  * Return pointer to the record under iterator.
 368  *
 369  * \param  di    - osd iterator
 370  * \param  attr  - not used
 371  */
 372 static int osd_it_acct_rec(const struct lu_env *env,
 373                            const struct dt_it *di,
 374                            struct dt_rec *dtrec, __u32 attr)
 375 {
 376         struct osd_it_quota     *it = (struct osd_it_quota *)di;
 377         const struct dt_key     *key = osd_it_acct_key(env, di);
 378         int                      rc;
 379
 380         ENTRY;
 381
 382         rc = osd_acct_index_lookup(env, &it->oiq_obj->oo_dt, dtrec, key,
 383                                    BYPASS_CAPA);
 384         RETURN(rc > 0 ? 0 : rc);
 385 }
 386
 387 /**
 388  * Returns cookie for current Iterator position.
 389  *
 390  * \param  di    - osd iterator
 391  */
 392 static __u64 osd_it_acct_store(const struct lu_env *env,
 393                                const struct dt_it *di)
 394 {
 395         struct osd_it_quota *it = (struct osd_it_quota *)di;
 396
 397         ENTRY;
 398         RETURN(it->oiq_id);
 399 }
 400
 401 /**
 402  * Restore iterator from cookie. if the \a hash isn't found,
 403  * restore the first valid record.
 404  *
 405  * \param  di    - osd iterator
 406  * \param  hash  - iterator location cookie
 407  *
 408  * \retval +ve   - di points to the first valid record
 409  * \retval  +1   - di points to exact matched hash
 410  * \retval -ve   - failure
 411  */
 412 static int osd_it_acct_load(const struct lu_env *env,
 413                             const struct dt_it *di, __u64 hash)
 414 {
 415         ENTRY;
 416         RETURN(osd_it_acct_get(env, (struct dt_it *)di,
 417                                (const struct dt_key *)&hash));
 418 }
 419
 420 /**
 421  * Index and Iterator operations for accounting objects
 422  */
 423 const struct dt_index_operations osd_acct_index_ops = {
 424         .dio_lookup     = osd_acct_index_lookup,
 425         .dio_it         = {
 426                 .init           = osd_it_acct_init,
 427                 .fini           = osd_it_acct_fini,
 428                 .get            = osd_it_acct_get,
 429                 .put            = osd_it_acct_put,
 430                 .next           = osd_it_acct_next,
 431                 .key            = osd_it_acct_key,
 432                 .key_size       = osd_it_acct_key_size,
 433                 .rec            = osd_it_acct_rec,
 434                 .store          = osd_it_acct_store,
 435                 .load           = osd_it_acct_load
 436         }
 437 };
 438
 439 static inline void osd_quota_swab(char *ptr, size_t size)
 440 {
 441         int offset;
 442
 443         LASSERT((size & (sizeof(__u64) - 1)) == 0);
 444
 445         for (offset = 0; offset < size; offset += sizeof(__u64))
 446              __swab64s((__u64 *)(ptr + offset));
 447 }
 448
 449 const struct dt_rec *osd_quota_pack(struct osd_object *obj,
 450                                     const struct dt_rec *rec,
 451                                     union lquota_rec *quota_rec)
 452 {
 453 #ifdef __BIG_ENDIAN
 454         struct iam_descr        *descr;
 455
 456         LASSERT(obj->oo_dir != NULL);
 457         descr = obj->oo_dir->od_container.ic_descr;
 458
 459         memcpy(quota_rec, rec, descr->id_rec_size);
 460
 461         osd_quota_swab((char *)quota_rec, descr->id_rec_size);
 462         return (const struct dt_rec *)quota_rec;
 463 #else
 464         return rec;
 465 #endif
 466 }
 467
 468 void osd_quota_unpack(struct osd_object *obj, const struct dt_rec *rec)
 469 {
 470 #ifdef __BIG_ENDIAN
 471         struct iam_descr *descr;
 472
 473         LASSERT(obj->oo_dir != NULL);
 474         descr = obj->oo_dir->od_container.ic_descr;
 475
 476         osd_quota_swab((char *)rec, descr->id_rec_size);
 477 #else
 478         return;
 479 #endif
 480 }
 481
 482 static inline int osd_qid_type(struct osd_thandle *oh, int i)
 483 {
 484         return (oh->ot_id_type & (1 << i)) ? GRPQUOTA : USRQUOTA;
 485 }
 486
 487 static inline void osd_qid_set_type(struct osd_thandle *oh, int i, int type)
 488 {
 489         oh->ot_id_type |= ((type == GRPQUOTA) ? (1 << i) : 0);
 490 }
 491
 492 /**
 493  * Reserve journal credits for quota files update first, then call
 494  * ->op_begin() to perform quota enforcement.
 495  *
 496  * \param  env     - the environment passed by the caller
 497  * \param  oh      - osd transaction handle
 498  * \param  qi      - quota id & space required for this operation
 499  * \param  obj     - osd object, could be NULL when it's under create
 500  * \param  enforce - whether to perform quota enforcement
 501  * \param  flags   - if the operation is write, return no user quota, no
 502  *                   group quota, or sync commit flags to the caller
 503  *
 504  * \retval 0       - success
 505  * \retval -ve     - failure
 506  */
 507 int osd_declare_qid(const struct lu_env *env, struct osd_thandle *oh,
 508                     struct lquota_id_info *qi, struct osd_object *obj,
 509                     bool enforce, int *flags)
 510 {
 511         struct osd_thread_info  *info = osd_oti_get(env);
 512         struct osd_device       *dev = info->oti_dev;
 513         struct qsd_instance     *qsd = dev->od_quota_slave;
 514         struct inode            *inode = NULL;
 515         int                      i, rc = 0, crd;
 516         bool                     found = false;
 517         ENTRY;
 518
 519         LASSERT(oh != NULL);
 520         LASSERTF(oh->ot_id_cnt <= OSD_MAX_UGID_CNT, "count=%d\n",
 521                  oh->ot_id_cnt);
 522
 523         for (i = 0; i < oh->ot_id_cnt; i++) {
 524                 if (oh->ot_id_array[i] == qi->lqi_id.qid_uid &&
 525                     osd_qid_type(oh, i) == qi->lqi_type) {
 526                         found = true;
 527                         break;
 528                 }
 529         }
 530
 531         if (!found) {
 532                 /* we need to account for credits for this new ID */
 533                 if (i >= OSD_MAX_UGID_CNT) {
 534                         CERROR("Too many(%d) trans qids!\n", i + 1);
 535                         RETURN(-EOVERFLOW);
 536                 }
 537
 538                 if (obj != NULL)
 539                         inode = obj->oo_inode;
 540
 541                 /* root ID entry should be always present in the quota file */
 542                 if (qi->lqi_id.qid_uid == 0) {
 543                         crd = 1;
 544                 } else {
 545                         /* used space for this ID could be dropped to zero,
 546                          * reserve extra credits for removing ID entry from
 547                          * the quota file */
 548                         if (qi->lqi_space < 0)
 549                                 crd = LDISKFS_QUOTA_DEL_BLOCKS(osd_sb(dev));
 550                         /* reserve credits for adding ID entry to the quota
 551                          * file if the i_dquot isn't initialized yet. */
 552                         else if (inode == NULL ||
 553                                  inode->i_dquot[qi->lqi_type] == NULL)
 554                                 crd = LDISKFS_QUOTA_INIT_BLOCKS(osd_sb(dev));
 555                         else
 556                                 crd = 1;
 557                 }
 558
 559                 osd_trans_declare_op(env, oh, OSD_OT_QUOTA, crd);
 560
 561                 oh->ot_id_array[i] = qi->lqi_id.qid_uid;
 562                 osd_qid_set_type(oh, i, qi->lqi_type);
 563                 oh->ot_id_cnt++;
 564         }
 565
 566         if (unlikely(qsd == NULL))
 567                 /* quota slave instance hasn't been allocated yet */
 568                 RETURN(0);
 569
 570         /* check quota */
 571         if (enforce)
 572                 rc = qsd_op_begin(env, qsd, oh->ot_quota_trans, qi, flags);
 573         RETURN(rc);
 574 }
 575
 576 /**
 577  * Wrapper for osd_declare_qid()
 578  *
 579  * \param  env    - the environment passed by the caller
 580  * \param  uid    - user id of the inode
 581  * \param  gid    - group id of the inode
 582  * \param  space  - how many blocks/inodes will be consumed/released
 583  * \param  oh     - osd transaction handle
 584  * \param  obj    - osd object, could be NULL when it's under create
 585  * \param  is_blk - block quota or inode quota?
 586  * \param  flags  - if the operation is write, return no user quota, no
 587  *                  group quota, or sync commit flags to the caller
 588  * \param force   - set to 1 when changes are performed by root user and thus
 589  *                  can't failed with EDQUOT
 590  *
 591  * \retval 0      - success
 592  * \retval -ve    - failure
 593  */
 594 int osd_declare_inode_qid(const struct lu_env *env, qid_t uid, qid_t gid,
 595                           long long space, struct osd_thandle *oh,
 596                           struct osd_object *obj, bool is_blk, int *flags,
 597                           bool force)
 598 {
 599         struct osd_thread_info  *info = osd_oti_get(env);
 600         struct lquota_id_info   *qi = &info->oti_qi;
 601         int                      rcu, rcg; /* user & group rc */
 602         ENTRY;
 603
 604         /* let's start with user quota */
 605         qi->lqi_id.qid_uid = uid;
 606         qi->lqi_type       = USRQUOTA;
 607         qi->lqi_space      = space;
 608         qi->lqi_is_blk     = is_blk;
 609         rcu = osd_declare_qid(env, oh, qi, obj, true, flags);
 610
 611         if (force && (rcu == -EDQUOT || rcu == -EINPROGRESS))
 612                 /* ignore EDQUOT & EINPROGRESS when changes are done by root */
 613                 rcu = 0;
 614
 615         /* For non-fatal error, we want to continue to get the noquota flags
 616          * for group id. This is only for commit write, which has @flags passed
 617          * in. See osd_declare_write_commit().
 618          * When force is set to true, we also want to proceed with the gid */
 619         if (rcu && (rcu != -EDQUOT || flags == NULL))
 620                 RETURN(rcu);
 621
 622         /* and now group quota */
 623         qi->lqi_id.qid_gid = gid;
 624         qi->lqi_type       = GRPQUOTA;
 625         rcg = osd_declare_qid(env, oh, qi, obj, true, flags);
 626
 627         if (force && (rcg == -EDQUOT || rcg == -EINPROGRESS))
 628                 /* as before, ignore EDQUOT & EINPROGRESS for root */
 629                 rcg = 0;
 630
 631         RETURN(rcu ? rcu : rcg);
 632 }
 633
 634 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 53, 0)
 635 /* Following code is used to migrate old admin quota files (in Linux quota
 636  * file v2 format) into the new quota global indexes (in IAM format). */
 637
 638 /* copied from osd_it_acct_get(), only changed the 'type' to -1 */
 639 static int osd_it_admin_get(const struct lu_env *env, struct dt_it *di,
 640                             const struct dt_key *key)
 641 {
 642         struct osd_it_quota     *it = (struct osd_it_quota *)di;
 643         int                      type = -1;
 644         qid_t                    dqid = *(qid_t *)key;
 645         loff_t                   offset;
 646         int                      rc;
 647         ENTRY;
 648
 649         offset = find_tree_dqentry(env, it->oiq_obj, type, dqid,
 650                                    LUSTRE_DQTREEOFF, 0, it);
 651         if (offset > 0) { /* Found */
 652                 RETURN(+1);
 653         } else if (offset < 0) { /* Error */
 654                 QUOTA_IT_READ_ERROR(it, (int)offset);
 655                 RETURN((int)offset);
 656         }
 657
 658         /* The @key is not found, move to the first valid entry */
 659         rc = walk_tree_dqentry(env, it->oiq_obj, type, it->oiq_blk[0], 0,
 660                                0, it);
 661         if (rc > 0)
 662                 /* no valid entry found */
 663                 rc = -ENOENT;
 664         RETURN(rc);
 665 }
 666
 667 static int osd_it_admin_load(const struct lu_env *env,
 668                              const struct dt_it *di, __u64 hash)
 669 {
 670         int rc;
 671         ENTRY;
 672
 673         rc = osd_it_admin_get(env, (struct dt_it *)di,
 674                               (const struct dt_key *)&hash);
 675         RETURN(rc);
 676 }
 677
 678 static int osd_it_admin_rec(const struct lu_env *env,
 679                             const struct dt_it *di,
 680                             struct dt_rec *dtrec, __u32 attr)
 681 {
 682         struct osd_it_quota     *it = (struct osd_it_quota *)di;
 683         struct lu_buf            buf;
 684         loff_t                   pos;
 685         int                      rc;
 686         struct lustre_disk_dqblk_v2 *dqblk =
 687                 (struct lustre_disk_dqblk_v2 *)dtrec;
 688         ENTRY;
 689
 690         buf.lb_buf = dqblk;
 691         buf.lb_len = sizeof(*dqblk);
 692
 693         pos = it->oiq_offset;
 694         rc = dt_record_read(env, &it->oiq_obj->oo_dt, &buf, &pos);
 695         RETURN(rc);
 696 }
 697
 698 /* copied from osd_it_acct_next(), only changed the 'type' to -1 */
 699 static int osd_it_admin_next(const struct lu_env *env, struct dt_it *di)
 700 {
 701         struct osd_it_quota     *it = (struct osd_it_quota *)di;
 702         int                      type = -1;
 703         int                      depth, rc;
 704         uint                     index;
 705         ENTRY;
 706
 707         /* Let's first check if there are any remaining valid entry in the
 708          * current leaf block. Start with the next entry after the current one.
 709          */
 710         depth = LUSTRE_DQTREEDEPTH;
 711         index = it->oiq_index[depth];
 712         if (++index < LUSTRE_DQSTRINBLK) {
 713                 /* Search for the next valid entry from current index */
 714                 rc = walk_block_dqentry(env, it->oiq_obj, type,
 715                                         it->oiq_blk[depth], index, it);
 716                 if (rc < 0) {
 717                         QUOTA_IT_READ_ERROR(it, rc);
 718                         RETURN(rc);
 719                 } else if (rc == 0) {
 720                         /* Found on entry, @it is already updated to the
 721                          * new position in walk_block_dqentry(). */
 722                         RETURN(0);
 723                 } else {
 724                         rc = osd_it_add_processed(it, depth);
 725                         if (rc)
 726                                 RETURN(rc);
 727                 }
 728         } else {
 729                 rc = osd_it_add_processed(it, depth);
 730                 if (rc)
 731                         RETURN(rc);
 732         }
 733         rc = 1;
 734
 735         /* We have consumed all the entries of the current leaf block, move on
 736          * to the next one. */
 737         depth--;
 738
 739         /* We keep searching as long as walk_tree_dqentry() returns +1
 740          * (= no valid entry found). */
 741         for (; depth >= 0 && rc > 0; depth--) {
 742                 index = it->oiq_index[depth];
 743                 if (++index > 0xff)
 744                         continue;
 745                 rc = walk_tree_dqentry(env, it->oiq_obj, type,
 746                                        it->oiq_blk[depth], depth, index, it);
 747         }
 748
 749         if (rc < 0)
 750                 QUOTA_IT_READ_ERROR(it, rc);
 751         RETURN(rc);
 752 }
 753
 754 const struct dt_index_operations osd_admin_index_ops = {
 755         .dio_lookup     = osd_acct_index_lookup,
 756         .dio_it         = {
 757                 .init     = osd_it_acct_init,
 758                 .fini     = osd_it_acct_fini,
 759                 .get      = osd_it_admin_get,
 760                 .put      = osd_it_acct_put,
 761                 .next     = osd_it_admin_next,
 762                 .key      = osd_it_acct_key,
 763                 .key_size = osd_it_acct_key_size,
 764                 .rec      = osd_it_admin_rec,
 765                 .store    = osd_it_acct_store,
 766                 .load     = osd_it_admin_load
 767         }
 768 };
 769
 770 static int convert_quota_file(const struct lu_env *env,
 771                               struct dt_object *old, struct dt_object *new,
 772                               bool isblk)
 773 {
 774         const struct dt_it_ops  *iops = &old->do_index_ops->dio_it;
 775         struct osd_object       *obj;
 776         struct lu_buf            buf;
 777         struct dt_it            *it;
 778         struct dt_key           *key;
 779         __u32                    grace;
 780         struct lquota_glb_rec   *glb_rec = NULL;
 781         loff_t                   pos;
 782         int                      rc;
 783         struct lustre_disk_dqblk_v2     *dqblk = NULL;
 784         struct lustre_disk_dqinfo       *dqinfo = NULL;
 785         ENTRY;
 786
 787         obj = osd_dt_obj(old);
 788         LASSERT(obj->oo_inode);
 789
 790         if (i_size_read(obj->oo_inode) == 0)
 791                 RETURN(0);
 792
 793         /* allocate buffers */
 794         OBD_ALLOC_PTR(dqinfo);
 795         if (dqinfo == NULL)
 796                 RETURN(-ENOMEM);
 797
 798         OBD_ALLOC_PTR(glb_rec);
 799         if (glb_rec == NULL)
 800                 GOTO(out, rc = -ENOMEM);
 801
 802         OBD_ALLOC_PTR(dqblk);
 803         if (dqblk == NULL)
 804                 GOTO(out, rc = -ENOMEM);
 805
 806         /* convert the old igrace/bgrace */
 807         buf.lb_buf = dqinfo;
 808         buf.lb_len = sizeof(*dqinfo);
 809         pos = LUSTRE_DQINFOOFF;
 810
 811         rc = dt_record_read(env, old, &buf, &pos);
 812         if (rc)
 813                 GOTO(out, rc);
 814
 815         /* keep it in little endian */
 816         grace = isblk ? dqinfo->dqi_bgrace : dqinfo->dqi_igrace;
 817         if (grace != 0) {
 818                 glb_rec->qbr_time = grace;
 819                 rc = lquota_disk_write_glb(env, new, 0, glb_rec);
 820                 if (rc)
 821                         GOTO(out, rc);
 822                 glb_rec->qbr_time = 0;
 823         }
 824
 825         /* iterate the old admin file, insert each record into the
 826          * new index file. */
 827         it = iops->init(env, old, 0, BYPASS_CAPA);
 828         if (IS_ERR(it))
 829                 GOTO(out, rc = PTR_ERR(it));
 830
 831         rc = iops->load(env, it, 0);
 832         if (rc == -ENOENT)
 833                 GOTO(out_it, rc = 0);
 834         else if (rc < 0)
 835                 GOTO(out_it, rc);
 836
 837         do {
 838                 key = iops->key(env, it);
 839                 if (IS_ERR(key))
 840                         GOTO(out_it, rc = PTR_ERR(key));
 841
 842                 /* skip the root user/group */
 843                 if (*((__u64 *)key) == 0)
 844                         goto next;
 845
 846                 rc = iops->rec(env, it, (struct dt_rec *)dqblk, 0);
 847                 if (rc)
 848                         GOTO(out_it, rc);
 849
 850                 /* keep the value in little endian */
 851                 glb_rec->qbr_hardlimit = isblk ? dqblk->dqb_bhardlimit :
 852                                                  dqblk->dqb_ihardlimit;
 853                 glb_rec->qbr_softlimit = isblk ? dqblk->dqb_bsoftlimit :
 854                                                  dqblk->dqb_isoftlimit;
 855
 856                 rc = lquota_disk_write_glb(env, new, *((__u64 *)key), glb_rec);
 857                 if (rc)
 858                         GOTO(out_it, rc);
 859 next:
 860                 rc = iops->next(env, it);
 861         } while (rc == 0);
 862
 863         /* reach the end */
 864         if (rc > 0)
 865                 rc = 0;
 866
 867 out_it:
 868         iops->put(env, it);
 869         iops->fini(env, it);
 870 out:
 871         if (dqblk != NULL)
 872                 OBD_FREE_PTR(dqblk);
 873         if (glb_rec != NULL)
 874                 OBD_FREE_PTR(glb_rec);
 875         if (dqinfo != NULL)
 876                 OBD_FREE_PTR(dqinfo);
 877         return rc;
 878 }
 879
 880 /* Nobdy else can access the global index now, it's safe to truncate and
 881  * reinitialize it */
 882 static int truncate_quota_index(const struct lu_env *env, struct dt_object *dt,
 883                                 const struct dt_index_features *feat)
 884 {
 885         struct osd_device       *osd = osd_obj2dev(osd_dt_obj(dt));
 886         struct thandle          *th;
 887         struct lu_attr          *attr;
 888         struct osd_thandle      *oth;
 889         struct inode            *inode;
 890         int                      rc;
 891         struct iam_container    *bag = &(osd_dt_obj(dt))->oo_dir->od_container;
 892         struct lu_buf           *lb = &osd_oti_get(env)->oti_buf;
 893         ENTRY;
 894
 895         LASSERT(bag->ic_root_bh != NULL);
 896         iam_container_fini(bag);
 897
 898         LASSERT(fid_seq(lu_object_fid(&dt->do_lu)) == FID_SEQ_QUOTA_GLB);
 899
 900         OBD_ALLOC_PTR(attr);
 901         if (attr == NULL)
 902                 RETURN(-ENOMEM);
 903
 904         attr->la_size = 0;
 905         attr->la_valid = LA_SIZE;
 906
 907         th = dt_trans_create(env, &osd->od_dt_dev);
 908         if (IS_ERR(th)) {
 909                 OBD_FREE_PTR(attr);
 910                 RETURN(PTR_ERR(th));
 911         }
 912
 913         rc = dt_declare_punch(env, dt, 0, OBD_OBJECT_EOF, th);
 914         if (rc)
 915                 GOTO(out, rc);
 916
 917         rc = dt_declare_attr_set(env, dt, attr, th);
 918         if (rc)
 919                 GOTO(out, rc);
 920
 921         inode = osd_dt_obj(dt)->oo_inode;
 922         LASSERT(inode);
 923
 924         /* iam_lfix_create() writes two blocks at the beginning */
 925         lb->lb_len = osd_sb(osd)->s_blocksize * 2;
 926         rc = dt_declare_record_write(env, dt, lb, 0, th);
 927         if (rc)
 928                 GOTO(out, rc);
 929
 930         rc = dt_trans_start_local(env, &osd->od_dt_dev, th);
 931         if (rc)
 932                 GOTO(out, rc);
 933
 934         dt_write_lock(env, dt, 0);
 935         rc = dt_punch(env, dt, 0, OBD_OBJECT_EOF, th, BYPASS_CAPA);
 936         if (rc)
 937                 GOTO(out_lock, rc);
 938
 939         rc = dt_attr_set(env, dt, attr, th, BYPASS_CAPA);
 940         if (rc)
 941                 GOTO(out_lock, rc);
 942
 943         oth = container_of(th, struct osd_thandle, ot_super);
 944
 945         if (feat->dif_flags & DT_IND_VARKEY)
 946                 rc = iam_lvar_create(osd_dt_obj(dt)->oo_inode,
 947                                      feat->dif_keysize_max,
 948                                      feat->dif_ptrsize,
 949                                      feat->dif_recsize_max, oth->ot_handle);
 950         else
 951                 rc = iam_lfix_create(osd_dt_obj(dt)->oo_inode,
 952                                      feat->dif_keysize_max,
 953                                      feat->dif_ptrsize,
 954                                      feat->dif_recsize_max, oth->ot_handle);
 955 out_lock:
 956         dt_write_unlock(env, dt);
 957 out:
 958         dt_trans_stop(env, &osd->od_dt_dev, th);
 959         OBD_FREE_PTR(attr);
 960
 961         if (rc == 0) {
 962                 rc  = iam_container_setup(bag);
 963                 if (rc != 0)
 964                         iam_container_fini(bag);
 965         }
 966         RETURN(rc);
 967 }
 968
 969 static int set_quota_index_version(const struct lu_env *env,
 970                                    struct dt_object *dt,
 971                                    dt_obj_version_t version)
 972 {
 973         struct osd_device       *osd = osd_obj2dev(osd_dt_obj(dt));
 974         struct thandle          *th;
 975         int                      rc;
 976         ENTRY;
 977
 978         th = dt_trans_create(env, &osd->od_dt_dev);
 979         if (IS_ERR(th))
 980                 RETURN(PTR_ERR(th));
 981
 982         rc = dt_declare_version_set(env, dt, th);
 983         if (rc)
 984                 GOTO(out, rc);
 985
 986         rc = dt_trans_start_local(env, &osd->od_dt_dev, th);
 987         if (rc)
 988                 GOTO(out, rc);
 989
 990         th->th_sync = 1;
 991         dt_version_set(env, dt, version, th);
 992 out:
 993         dt_trans_stop(env, &osd->od_dt_dev, th);
 994         RETURN(rc);
 995 }
 996
 997 int osd_quota_migration(const struct lu_env *env, struct dt_object *dt,
 998                         const struct dt_index_features *feat)
 999 {
1000         struct osd_thread_info  *oti = osd_oti_get(env);
1001         struct osd_device       *osd = osd_obj2dev(osd_dt_obj(dt));
1002         struct dt_object        *root, *parent = NULL, *admin = NULL;
1003         dt_obj_version_t         version;
1004         char                    *fname;
1005         bool                     isblk = false, converted = false;
1006         int                      rc;
1007         ENTRY;
1008
1009         /* not newly created global index */
1010         version = dt_version_get(env, dt);
1011         if (version != 0)
1012                 RETURN(0);
1013
1014         /* locate root */
1015         rc = dt_root_get(env, &osd->od_dt_dev, &oti->oti_fid);
1016         if (rc) {
1017                 CERROR("%s: Can't get root FID, rc:%d\n", osd->od_svname, rc);
1018                 RETURN(rc);
1019         }
1020
1021         root = dt_locate(env, &osd->od_dt_dev, &oti->oti_fid);
1022         if (IS_ERR(root)) {
1023                 CERROR("%s: Failed to locate root "DFID", rc:%ld\n",
1024                        osd->od_svname, PFID(&oti->oti_fid), PTR_ERR(root));
1025                 RETURN(PTR_ERR(root));
1026         }
1027
1028         /* locate /OBJECTS */
1029         rc = dt_lookup_dir(env, root, OBJECTS, &oti->oti_fid);
1030         if (rc == -ENOENT) {
1031                 GOTO(out, rc = 0);
1032         } else if (rc) {
1033                 CERROR("%s: Failed to lookup %s, rc:%d\n",
1034                        osd->od_svname, OBJECTS, rc);
1035                 GOTO(out, rc);
1036         }
1037
1038         parent = dt_locate(env, &osd->od_dt_dev, &oti->oti_fid);
1039         if (IS_ERR(parent)) {
1040                 CERROR("%s: Failed to locate %s "DFID", rc:%ld\n",
1041                        osd->od_svname, OBJECTS, PFID(&oti->oti_fid),
1042                        PTR_ERR(parent));
1043                 GOTO(out, rc = PTR_ERR(parent));
1044         }
1045
1046         /* locate quota admin file */
1047         if (feat == &dt_quota_iusr_features) {
1048                 fname = ADMIN_USR;
1049                 isblk = false;
1050         } else if (feat == &dt_quota_busr_features) {
1051                 fname = ADMIN_USR;
1052                 isblk = true;
1053         } else if (feat == &dt_quota_igrp_features) {
1054                 fname = ADMIN_GRP;
1055                 isblk = false;
1056         } else {
1057                 fname = ADMIN_GRP;
1058                 isblk = true;
1059         }
1060
1061         rc = dt_lookup_dir(env, parent, fname, &oti->oti_fid);
1062         if (rc == -ENOENT) {
1063                 GOTO(out, rc = 0);
1064         } else if (rc) {
1065                 CERROR("%s: Failed to lookup %s, rc:%d\n",
1066                        osd->od_svname, fname, rc);
1067                 GOTO(out, rc);
1068         }
1069
1070         admin = dt_locate(env, &osd->od_dt_dev, &oti->oti_fid);
1071         if (IS_ERR(admin)) {
1072                 CERROR("%s: Failed to locate %s "DFID", rc:%d\n",
1073                        osd->od_svname, fname, PFID(&oti->oti_fid), rc);
1074                 GOTO(out, rc = PTR_ERR(admin));
1075         }
1076
1077         if (!dt_object_exists(admin)) {
1078                 CERROR("%s: Old admin file %s doesn't exist, but is still "
1079                        " referenced in parent directory.\n",
1080                        osd->od_svname, fname);
1081                 GOTO(out, rc = -ENOENT);
1082         }
1083
1084         /* truncate the new quota index file in case of any leftovers
1085          * from last failed migration */
1086         rc = truncate_quota_index(env, dt, feat);
1087         if (rc) {
1088                 CERROR("%s: Failed to truncate the quota index "DFID", rc:%d\n",
1089                        osd->od_svname, PFID(lu_object_fid(&dt->do_lu)), rc);
1090                 GOTO(out, rc);
1091         }
1092
1093         /* set up indexing operations for the admin file */
1094         admin->do_index_ops = &osd_admin_index_ops;
1095
1096         LCONSOLE_INFO("%s: Migrate %s quota from old admin quota file(%s) to "
1097                       "new IAM quota index("DFID").\n", osd->od_svname,
1098                       isblk ? "block" : "inode", fname,
1099                       PFID(lu_object_fid(&dt->do_lu)));
1100
1101         /* iterate the admin quota file, and insert each record into
1102          * the new index file */
1103         rc = convert_quota_file(env, admin, dt, isblk);
1104         if (rc)
1105                 CERROR("%s: Migrate old admin quota file(%s) failed, rc:%d\n",
1106                        osd->od_svname, fname, rc);
1107         converted = true;
1108 out:
1109         /* if no migration happen, we need to set the default grace time. */
1110         if (!converted && rc == 0) {
1111                 struct lquota_glb_rec *rec = &oti->oti_quota_rec.lqr_glb_rec;
1112
1113                 rec->qbr_hardlimit = 0;
1114                 rec->qbr_softlimit = 0;
1115                 rec->qbr_granted = 0;
1116                 rec->qbr_time = isblk ? MAX_DQ_TIME : MAX_IQ_TIME;
1117
1118                 rc = lquota_disk_write_glb(env, dt, 0, rec);
1119                 if (rc)
1120                         CERROR("%s: Failed to set default grace time for "
1121                                "index("DFID"), rc:%d\n", osd->od_svname,
1122                                PFID(lu_object_fid(&dt->do_lu)), rc);
1123         }
1124
1125         /* bump index version to 1 (or 2 if migration happened), so the
1126          * migration will be skipped next time. */
1127         if (rc == 0) {
1128                 rc = set_quota_index_version(env , dt, converted ? 2 : 1);
1129                 if (rc)
1130                         CERROR("%s: Failed to set quota index("DFID") "
1131                                "version, rc:%d\n", osd->od_svname,
1132                                PFID(lu_object_fid(&dt->do_lu)), rc);
1133         }
1134
1135         if (admin && !IS_ERR(admin))
1136                 lu_object_put(env, &admin->do_lu);
1137         if (parent && !IS_ERR(parent))
1138                 lu_object_put(env, &parent->do_lu);
1139         lu_object_put(env, &root->do_lu);
1140
1141         RETURN(rc);
1142 }
1143 #endif /* LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 53, 0) */