lustre/obdclass/dt_object.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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, 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/obdclass/dt_object.c
  37  *
  38  * Dt Object.
  39  * Generic functions from dt_object.h
  40  *
  41  * Author: Nikita Danilov <nikita@clusterfs.com>
  42  */
  43
  44 #define DEBUG_SUBSYSTEM S_CLASS
  45
  46 #include <obd.h>
  47 #include <dt_object.h>
  48 #include <libcfs/list.h>
  49 /* fid_be_to_cpu() */
  50 #include <lustre_fid.h>
  51
  52 #include <lustre_quota.h>
  53
  54 /* context key constructor/destructor: dt_global_key_init, dt_global_key_fini */
  55 LU_KEY_INIT(dt_global, struct dt_thread_info);
  56 LU_KEY_FINI(dt_global, struct dt_thread_info);
  57
  58 struct lu_context_key dt_key = {
  59         .lct_tags = LCT_MD_THREAD | LCT_DT_THREAD | LCT_MG_THREAD | LCT_LOCAL,
  60         .lct_init = dt_global_key_init,
  61         .lct_fini = dt_global_key_fini
  62 };
  63 EXPORT_SYMBOL(dt_key);
  64
  65 /* no lock is necessary to protect the list, because call-backs
  66  * are added during system startup. Please refer to "struct dt_device".
  67  */
  68 void dt_txn_callback_add(struct dt_device *dev, struct dt_txn_callback *cb)
  69 {
  70         list_add(&cb->dtc_linkage, &dev->dd_txn_callbacks);
  71 }
  72 EXPORT_SYMBOL(dt_txn_callback_add);
  73
  74 void dt_txn_callback_del(struct dt_device *dev, struct dt_txn_callback *cb)
  75 {
  76         list_del_init(&cb->dtc_linkage);
  77 }
  78 EXPORT_SYMBOL(dt_txn_callback_del);
  79
  80 int dt_txn_hook_start(const struct lu_env *env,
  81                       struct dt_device *dev, struct thandle *th)
  82 {
  83         int rc = 0;
  84         struct dt_txn_callback *cb;
  85
  86         if (th->th_local)
  87                 return 0;
  88
  89         list_for_each_entry(cb, &dev->dd_txn_callbacks, dtc_linkage) {
  90                 if (cb->dtc_txn_start == NULL ||
  91                     !(cb->dtc_tag & env->le_ctx.lc_tags))
  92                         continue;
  93                 rc = cb->dtc_txn_start(env, th, cb->dtc_cookie);
  94                 if (rc < 0)
  95                         break;
  96         }
  97         return rc;
  98 }
  99 EXPORT_SYMBOL(dt_txn_hook_start);
 100
 101 int dt_txn_hook_stop(const struct lu_env *env, struct thandle *txn)
 102 {
 103         struct dt_device       *dev = txn->th_dev;
 104         struct dt_txn_callback *cb;
 105         int                     rc = 0;
 106
 107         if (txn->th_local)
 108                 return 0;
 109
 110         list_for_each_entry(cb, &dev->dd_txn_callbacks, dtc_linkage) {
 111                 if (cb->dtc_txn_stop == NULL ||
 112                     !(cb->dtc_tag & env->le_ctx.lc_tags))
 113                         continue;
 114                 rc = cb->dtc_txn_stop(env, txn, cb->dtc_cookie);
 115                 if (rc < 0)
 116                         break;
 117         }
 118         return rc;
 119 }
 120 EXPORT_SYMBOL(dt_txn_hook_stop);
 121
 122 void dt_txn_hook_commit(struct thandle *txn)
 123 {
 124         struct dt_txn_callback *cb;
 125
 126         if (txn->th_local)
 127                 return;
 128
 129         list_for_each_entry(cb, &txn->th_dev->dd_txn_callbacks,
 130                             dtc_linkage) {
 131                 if (cb->dtc_txn_commit)
 132                         cb->dtc_txn_commit(txn, cb->dtc_cookie);
 133         }
 134 }
 135 EXPORT_SYMBOL(dt_txn_hook_commit);
 136
 137 int dt_device_init(struct dt_device *dev, struct lu_device_type *t)
 138 {
 139         INIT_LIST_HEAD(&dev->dd_txn_callbacks);
 140         return lu_device_init(&dev->dd_lu_dev, t);
 141 }
 142 EXPORT_SYMBOL(dt_device_init);
 143
 144 void dt_device_fini(struct dt_device *dev)
 145 {
 146         lu_device_fini(&dev->dd_lu_dev);
 147 }
 148 EXPORT_SYMBOL(dt_device_fini);
 149
 150 int dt_object_init(struct dt_object *obj,
 151                    struct lu_object_header *h, struct lu_device *d)
 152
 153 {
 154         return lu_object_init(&obj->do_lu, h, d);
 155 }
 156 EXPORT_SYMBOL(dt_object_init);
 157
 158 void dt_object_fini(struct dt_object *obj)
 159 {
 160         lu_object_fini(&obj->do_lu);
 161 }
 162 EXPORT_SYMBOL(dt_object_fini);
 163
 164 int dt_try_as_dir(const struct lu_env *env, struct dt_object *obj)
 165 {
 166         if (obj->do_index_ops == NULL)
 167                 obj->do_ops->do_index_try(env, obj, &dt_directory_features);
 168         return obj->do_index_ops != NULL;
 169 }
 170 EXPORT_SYMBOL(dt_try_as_dir);
 171
 172 enum dt_format_type dt_mode_to_dft(__u32 mode)
 173 {
 174         enum dt_format_type result;
 175
 176         switch (mode & S_IFMT) {
 177         case S_IFDIR:
 178                 result = DFT_DIR;
 179                 break;
 180         case S_IFREG:
 181                 result = DFT_REGULAR;
 182                 break;
 183         case S_IFLNK:
 184                 result = DFT_SYM;
 185                 break;
 186         case S_IFCHR:
 187         case S_IFBLK:
 188         case S_IFIFO:
 189         case S_IFSOCK:
 190                 result = DFT_NODE;
 191                 break;
 192         default:
 193                 LBUG();
 194                 break;
 195         }
 196         return result;
 197 }
 198 EXPORT_SYMBOL(dt_mode_to_dft);
 199
 200 /**
 201  * lookup fid for object named \a name in directory \a dir.
 202  */
 203
 204 int dt_lookup_dir(const struct lu_env *env, struct dt_object *dir,
 205                   const char *name, struct lu_fid *fid)
 206 {
 207         if (dt_try_as_dir(env, dir))
 208                 return dt_lookup(env, dir, (struct dt_rec *)fid,
 209                                  (const struct dt_key *)name, BYPASS_CAPA);
 210         return -ENOTDIR;
 211 }
 212 EXPORT_SYMBOL(dt_lookup_dir);
 213
 214 /* this differs from dt_locate by top_dev as parameter
 215  * but not one from lu_site */
 216 struct dt_object *dt_locate_at(const struct lu_env *env,
 217                                struct dt_device *dev,
 218                                const struct lu_fid *fid,
 219                                struct lu_device *top_dev,
 220                                const struct lu_object_conf *conf)
 221 {
 222         struct lu_object *lo;
 223         struct lu_object *n;
 224
 225         lo = lu_object_find_at(env, top_dev, fid, conf);
 226         if (IS_ERR(lo))
 227                 return ERR_PTR(PTR_ERR(lo));
 228
 229         LASSERT(lo != NULL);
 230
 231         list_for_each_entry(n, &lo->lo_header->loh_layers, lo_linkage) {
 232                 if (n->lo_dev == &dev->dd_lu_dev)
 233                         return container_of0(n, struct dt_object, do_lu);
 234         }
 235
 236         return ERR_PTR(-ENOENT);
 237 }
 238 EXPORT_SYMBOL(dt_locate_at);
 239
 240 /**
 241  * find a object named \a entry in given \a dfh->dfh_o directory.
 242  */
 243 static int dt_find_entry(const struct lu_env *env, const char *entry, void *data)
 244 {
 245         struct dt_find_hint  *dfh = data;
 246         struct dt_device     *dt = dfh->dfh_dt;
 247         struct lu_fid        *fid = dfh->dfh_fid;
 248         struct dt_object     *obj = dfh->dfh_o;
 249         int                   result;
 250
 251         result = dt_lookup_dir(env, obj, entry, fid);
 252         lu_object_put(env, &obj->do_lu);
 253         if (result == 0) {
 254                 obj = dt_locate(env, dt, fid);
 255                 if (IS_ERR(obj))
 256                         result = PTR_ERR(obj);
 257         }
 258         dfh->dfh_o = obj;
 259         return result;
 260 }
 261
 262 /**
 263  * Abstract function which parses path name. This function feeds
 264  * path component to \a entry_func.
 265  */
 266 int dt_path_parser(const struct lu_env *env,
 267                    char *path, dt_entry_func_t entry_func,
 268                    void *data)
 269 {
 270         char *e;
 271         int rc = 0;
 272
 273         while (1) {
 274                 e = strsep(&path, "/");
 275                 if (e == NULL)
 276                         break;
 277
 278                 if (e[0] == 0) {
 279                         if (!path || path[0] == '\0')
 280                                 break;
 281                         continue;
 282                 }
 283                 rc = entry_func(env, e, data);
 284                 if (rc)
 285                         break;
 286         }
 287
 288         return rc;
 289 }
 290
 291 struct dt_object *
 292 dt_store_resolve(const struct lu_env *env, struct dt_device *dt,
 293                  const char *path, struct lu_fid *fid)
 294 {
 295         struct dt_thread_info *info = dt_info(env);
 296         struct dt_find_hint   *dfh = &info->dti_dfh;
 297         struct dt_object      *obj;
 298         int                    result;
 299
 300
 301         dfh->dfh_dt = dt;
 302         dfh->dfh_fid = fid;
 303
 304         strlcpy(info->dti_buf, path, sizeof(info->dti_buf));
 305
 306         result = dt->dd_ops->dt_root_get(env, dt, fid);
 307         if (result == 0) {
 308                 obj = dt_locate(env, dt, fid);
 309                 if (!IS_ERR(obj)) {
 310                         dfh->dfh_o = obj;
 311                         result = dt_path_parser(env, info->dti_buf,
 312                                                 dt_find_entry, dfh);
 313                         if (result != 0)
 314                                 obj = ERR_PTR(result);
 315                         else
 316                                 obj = dfh->dfh_o;
 317                 }
 318         } else {
 319                 obj = ERR_PTR(result);
 320         }
 321         return obj;
 322 }
 323 EXPORT_SYMBOL(dt_store_resolve);
 324
 325 static struct dt_object *dt_reg_open(const struct lu_env *env,
 326                                      struct dt_device *dt,
 327                                      struct dt_object *p,
 328                                      const char *name,
 329                                      struct lu_fid *fid)
 330 {
 331         struct dt_object *o;
 332         int result;
 333
 334         result = dt_lookup_dir(env, p, name, fid);
 335         if (result == 0){
 336                 o = dt_locate(env, dt, fid);
 337         }
 338         else
 339                 o = ERR_PTR(result);
 340
 341         return o;
 342 }
 343
 344 /**
 345  * Open dt object named \a filename from \a dirname directory.
 346  *      \param  dt      dt device
 347  *      \param  fid     on success, object fid is stored in *fid
 348  */
 349 struct dt_object *dt_store_open(const struct lu_env *env,
 350                                 struct dt_device *dt,
 351                                 const char *dirname,
 352                                 const char *filename,
 353                                 struct lu_fid *fid)
 354 {
 355         struct dt_object *file;
 356         struct dt_object *dir;
 357
 358         dir = dt_store_resolve(env, dt, dirname, fid);
 359         if (!IS_ERR(dir)) {
 360                 file = dt_reg_open(env, dt, dir,
 361                                    filename, fid);
 362                 lu_object_put(env, &dir->do_lu);
 363         } else {
 364                 file = dir;
 365         }
 366         return file;
 367 }
 368 EXPORT_SYMBOL(dt_store_open);
 369
 370 struct dt_object *dt_find_or_create(const struct lu_env *env,
 371                                     struct dt_device *dt,
 372                                     const struct lu_fid *fid,
 373                                     struct dt_object_format *dof,
 374                                     struct lu_attr *at)
 375 {
 376         struct dt_object *dto;
 377         struct thandle *th;
 378         int rc;
 379
 380         ENTRY;
 381
 382         dto = dt_locate(env, dt, fid);
 383         if (IS_ERR(dto))
 384                 RETURN(dto);
 385
 386         LASSERT(dto != NULL);
 387         if (dt_object_exists(dto))
 388                 RETURN(dto);
 389
 390         th = dt_trans_create(env, dt);
 391         if (IS_ERR(th))
 392                 GOTO(out, rc = PTR_ERR(th));
 393
 394         rc = dt_declare_create(env, dto, at, NULL, dof, th);
 395         if (rc)
 396                 GOTO(trans_stop, rc);
 397
 398         rc = dt_trans_start_local(env, dt, th);
 399         if (rc)
 400                 GOTO(trans_stop, rc);
 401
 402         dt_write_lock(env, dto, 0);
 403         if (dt_object_exists(dto))
 404                 GOTO(unlock, rc = 0);
 405
 406         CDEBUG(D_OTHER, "create new object "DFID"\n", PFID(fid));
 407
 408         rc = dt_create(env, dto, at, NULL, dof, th);
 409         if (rc)
 410                 GOTO(unlock, rc);
 411         LASSERT(dt_object_exists(dto));
 412 unlock:
 413         dt_write_unlock(env, dto);
 414 trans_stop:
 415         dt_trans_stop(env, dt, th);
 416 out:
 417         if (rc) {
 418                 lu_object_put(env, &dto->do_lu);
 419                 RETURN(ERR_PTR(rc));
 420         }
 421         RETURN(dto);
 422 }
 423 EXPORT_SYMBOL(dt_find_or_create);
 424
 425 /* dt class init function. */
 426 int dt_global_init(void)
 427 {
 428         int result;
 429
 430         LU_CONTEXT_KEY_INIT(&dt_key);
 431         result = lu_context_key_register(&dt_key);
 432         return result;
 433 }
 434
 435 void dt_global_fini(void)
 436 {
 437         lu_context_key_degister(&dt_key);
 438 }
 439
 440 /**
 441  * Generic read helper. May return an error for partial reads.
 442  *
 443  * \param env  lustre environment
 444  * \param dt   object to be read
 445  * \param buf  lu_buf to be filled, with buffer pointer and length
 446  * \param pos position to start reading, updated as data is read
 447  *
 448  * \retval real size of data read
 449  * \retval -ve errno on failure
 450  */
 451 int dt_read(const struct lu_env *env, struct dt_object *dt,
 452             struct lu_buf *buf, loff_t *pos)
 453 {
 454         LASSERTF(dt != NULL, "dt is NULL when we want to read record\n");
 455         return dt->do_body_ops->dbo_read(env, dt, buf, pos, BYPASS_CAPA);
 456 }
 457 EXPORT_SYMBOL(dt_read);
 458
 459 /**
 460  * Read structures of fixed size from storage.  Unlike dt_read(), using
 461  * dt_record_read() will return an error for partial reads.
 462  *
 463  * \param env  lustre environment
 464  * \param dt   object to be read
 465  * \param buf  lu_buf to be filled, with buffer pointer and length
 466  * \param pos position to start reading, updated as data is read
 467  *
 468  * \retval 0 on successfully reading full buffer
 469  * \retval -EFAULT on short read
 470  * \retval -ve errno on failure
 471  */
 472 int dt_record_read(const struct lu_env *env, struct dt_object *dt,
 473                    struct lu_buf *buf, loff_t *pos)
 474 {
 475         int rc;
 476
 477         LASSERTF(dt != NULL, "dt is NULL when we want to read record\n");
 478
 479         rc = dt->do_body_ops->dbo_read(env, dt, buf, pos, BYPASS_CAPA);
 480
 481         if (rc == buf->lb_len)
 482                 rc = 0;
 483         else if (rc >= 0)
 484                 rc = -EFAULT;
 485         return rc;
 486 }
 487 EXPORT_SYMBOL(dt_record_read);
 488
 489 int dt_record_write(const struct lu_env *env, struct dt_object *dt,
 490                     const struct lu_buf *buf, loff_t *pos, struct thandle *th)
 491 {
 492         int rc;
 493
 494         LASSERTF(dt != NULL, "dt is NULL when we want to write record\n");
 495         LASSERT(th != NULL);
 496         LASSERT(dt->do_body_ops);
 497         LASSERT(dt->do_body_ops->dbo_write);
 498         rc = dt->do_body_ops->dbo_write(env, dt, buf, pos, th, BYPASS_CAPA, 1);
 499         if (rc == buf->lb_len)
 500                 rc = 0;
 501         else if (rc >= 0)
 502                 rc = -EFAULT;
 503         return rc;
 504 }
 505 EXPORT_SYMBOL(dt_record_write);
 506
 507 int dt_declare_version_set(const struct lu_env *env, struct dt_object *o,
 508                            struct thandle *th)
 509 {
 510         struct lu_buf vbuf;
 511         char *xname = XATTR_NAME_VERSION;
 512
 513         LASSERT(o);
 514         vbuf.lb_buf = NULL;
 515         vbuf.lb_len = sizeof(dt_obj_version_t);
 516         return dt_declare_xattr_set(env, o, &vbuf, xname, 0, th);
 517
 518 }
 519 EXPORT_SYMBOL(dt_declare_version_set);
 520
 521 void dt_version_set(const struct lu_env *env, struct dt_object *o,
 522                     dt_obj_version_t version, struct thandle *th)
 523 {
 524         struct lu_buf vbuf;
 525         char *xname = XATTR_NAME_VERSION;
 526         int rc;
 527
 528         LASSERT(o);
 529         vbuf.lb_buf = &version;
 530         vbuf.lb_len = sizeof(version);
 531
 532         rc = dt_xattr_set(env, o, &vbuf, xname, 0, th, BYPASS_CAPA);
 533         if (rc < 0)
 534                 CDEBUG(D_INODE, "Can't set version, rc %d\n", rc);
 535         return;
 536 }
 537 EXPORT_SYMBOL(dt_version_set);
 538
 539 dt_obj_version_t dt_version_get(const struct lu_env *env, struct dt_object *o)
 540 {
 541         struct lu_buf vbuf;
 542         char *xname = XATTR_NAME_VERSION;
 543         dt_obj_version_t version;
 544         int rc;
 545
 546         LASSERT(o);
 547         vbuf.lb_buf = &version;
 548         vbuf.lb_len = sizeof(version);
 549         rc = dt_xattr_get(env, o, &vbuf, xname, BYPASS_CAPA);
 550         if (rc != sizeof(version)) {
 551                 CDEBUG(D_INODE, "Can't get version, rc %d\n", rc);
 552                 version = 0;
 553         }
 554         return version;
 555 }
 556 EXPORT_SYMBOL(dt_version_get);
 557
 558 /* list of all supported index types */
 559
 560 /* directories */
 561 const struct dt_index_features dt_directory_features;
 562 EXPORT_SYMBOL(dt_directory_features);
 563
 564 /* scrub iterator */
 565 const struct dt_index_features dt_otable_features;
 566 EXPORT_SYMBOL(dt_otable_features);
 567
 568 /* lfsck orphan */
 569 const struct dt_index_features dt_lfsck_orphan_features = {
 570         .dif_flags              = 0,
 571         .dif_keysize_min        = sizeof(struct lu_fid),
 572         .dif_keysize_max        = sizeof(struct lu_fid),
 573         .dif_recsize_min        = sizeof(struct lu_orphan_rec),
 574         .dif_recsize_max        = sizeof(struct lu_orphan_rec),
 575         .dif_ptrsize            = 4
 576 };
 577 EXPORT_SYMBOL(dt_lfsck_orphan_features);
 578
 579 /* lfsck */
 580 const struct dt_index_features dt_lfsck_features = {
 581         .dif_flags              = DT_IND_UPDATE,
 582         .dif_keysize_min        = sizeof(struct lu_fid),
 583         .dif_keysize_max        = sizeof(struct lu_fid),
 584         .dif_recsize_min        = sizeof(__u8),
 585         .dif_recsize_max        = sizeof(__u8),
 586         .dif_ptrsize            = 4
 587 };
 588 EXPORT_SYMBOL(dt_lfsck_features);
 589
 590 /* accounting indexes */
 591 const struct dt_index_features dt_acct_features = {
 592         .dif_flags              = DT_IND_UPDATE,
 593         .dif_keysize_min        = sizeof(__u64), /* 64-bit uid/gid */
 594         .dif_keysize_max        = sizeof(__u64), /* 64-bit uid/gid */
 595         .dif_recsize_min        = sizeof(struct lquota_acct_rec), /* 16 bytes */
 596         .dif_recsize_max        = sizeof(struct lquota_acct_rec), /* 16 bytes */
 597         .dif_ptrsize            = 4
 598 };
 599 EXPORT_SYMBOL(dt_acct_features);
 600
 601 /* global quota files */
 602 const struct dt_index_features dt_quota_glb_features = {
 603         .dif_flags              = DT_IND_UPDATE,
 604         /* a different key would have to be used for per-directory quota */
 605         .dif_keysize_min        = sizeof(__u64), /* 64-bit uid/gid */
 606         .dif_keysize_max        = sizeof(__u64), /* 64-bit uid/gid */
 607         .dif_recsize_min        = sizeof(struct lquota_glb_rec), /* 32 bytes */
 608         .dif_recsize_max        = sizeof(struct lquota_glb_rec), /* 32 bytes */
 609         .dif_ptrsize            = 4
 610 };
 611 EXPORT_SYMBOL(dt_quota_glb_features);
 612
 613 /* slave quota files */
 614 const struct dt_index_features dt_quota_slv_features = {
 615         .dif_flags              = DT_IND_UPDATE,
 616         /* a different key would have to be used for per-directory quota */
 617         .dif_keysize_min        = sizeof(__u64), /* 64-bit uid/gid */
 618         .dif_keysize_max        = sizeof(__u64), /* 64-bit uid/gid */
 619         .dif_recsize_min        = sizeof(struct lquota_slv_rec), /* 8 bytes */
 620         .dif_recsize_max        = sizeof(struct lquota_slv_rec), /* 8 bytes */
 621         .dif_ptrsize            = 4
 622 };
 623 EXPORT_SYMBOL(dt_quota_slv_features);
 624
 625 /* helper function returning what dt_index_features structure should be used
 626  * based on the FID sequence. This is used by OBD_IDX_READ RPC */
 627 static inline const struct dt_index_features *dt_index_feat_select(__u64 seq,
 628                                                                    __u32 mode)
 629 {
 630         if (seq == FID_SEQ_QUOTA_GLB) {
 631                 /* global quota index */
 632                 if (!S_ISREG(mode))
 633                         /* global quota index should be a regular file */
 634                         return ERR_PTR(-ENOENT);
 635                 return &dt_quota_glb_features;
 636         } else if (seq == FID_SEQ_QUOTA) {
 637                 /* quota slave index */
 638                 if (!S_ISREG(mode))
 639                         /* slave index should be a regular file */
 640                         return ERR_PTR(-ENOENT);
 641                 return &dt_quota_slv_features;
 642         } else if (seq == FID_SEQ_LAYOUT_RBTREE){
 643                 return &dt_lfsck_orphan_features;
 644         } else if (seq >= FID_SEQ_NORMAL) {
 645                 /* object is part of the namespace, verify that it is a
 646                  * directory */
 647                 if (!S_ISDIR(mode))
 648                         /* sorry, we can only deal with directory */
 649                         return ERR_PTR(-ENOTDIR);
 650                 return &dt_directory_features;
 651         }
 652
 653         return ERR_PTR(-EOPNOTSUPP);
 654 }
 655
 656 /*
 657  * Fill a lu_idxpage with key/record pairs read for transfer via OBD_IDX_READ
 658  * RPC
 659  *
 660  * \param env - is the environment passed by the caller
 661  * \param lp  - is a pointer to the lu_page to fill
 662  * \param nob - is the maximum number of bytes that should be copied
 663  * \param iops - is the index operation vector associated with the index object
 664  * \param it   - is a pointer to the current iterator
 665  * \param attr - is the index attribute to pass to iops->rec()
 666  * \param arg  - is a pointer to the idx_info structure
 667  */
 668 static int dt_index_page_build(const struct lu_env *env, union lu_page *lp,
 669                                int nob, const struct dt_it_ops *iops,
 670                                struct dt_it *it, __u32 attr, void *arg)
 671 {
 672         struct idx_info         *ii = (struct idx_info *)arg;
 673         struct lu_idxpage       *lip = &lp->lp_idx;
 674         char                    *entry;
 675         int                      rc, size;
 676         ENTRY;
 677
 678         /* initialize the header of the new container */
 679         memset(lip, 0, LIP_HDR_SIZE);
 680         lip->lip_magic = LIP_MAGIC;
 681         nob           -= LIP_HDR_SIZE;
 682
 683         /* compute size needed to store a key/record pair */
 684         size = ii->ii_recsize + ii->ii_keysize;
 685         if ((ii->ii_flags & II_FL_NOHASH) == 0)
 686                 /* add hash if the client wants it */
 687                 size += sizeof(__u64);
 688
 689         entry = lip->lip_entries;
 690         do {
 691                 char            *tmp_entry = entry;
 692                 struct dt_key   *key;
 693                 __u64           hash;
 694                 __u16           keysize;
 695                 __u16           recsize;
 696
 697                 /* fetch 64-bit hash value */
 698                 hash = iops->store(env, it);
 699                 ii->ii_hash_end = hash;
 700
 701                 if (OBD_FAIL_CHECK(OBD_FAIL_OBD_IDX_READ_BREAK)) {
 702                         if (lip->lip_nr != 0)
 703                                 GOTO(out, rc = 0);
 704                 }
 705
 706                 if (nob < size) {
 707                         if (lip->lip_nr == 0)
 708                                 GOTO(out, rc = -EINVAL);
 709                         GOTO(out, rc = 0);
 710                 }
 711
 712                 if (!(ii->ii_flags & II_FL_NOHASH)) {
 713                         /* client wants to the 64-bit hash value associated with
 714                          * each record */
 715                         memcpy(tmp_entry, &hash, sizeof(hash));
 716                         tmp_entry += sizeof(hash);
 717                 }
 718
 719                 if (ii->ii_flags & II_FL_VARKEY)
 720                         keysize = iops->key_size(env, it);
 721                 else
 722                         keysize = ii->ii_keysize;
 723
 724                 if (!(ii->ii_flags & II_FL_NOKEY)) {
 725                         /* then the key value */
 726                         key = iops->key(env, it);
 727                         memcpy(tmp_entry, key, keysize);
 728                         tmp_entry += keysize;
 729                 }
 730
 731                 /* and finally the record */
 732                 rc = iops->rec(env, it, (struct dt_rec *)tmp_entry, attr);
 733                 if (rc != -ESTALE) {
 734                         if (rc != 0)
 735                                 GOTO(out, rc);
 736
 737                         /* hash/key/record successfully copied! */
 738                         lip->lip_nr++;
 739                         if (unlikely(lip->lip_nr == 1 && ii->ii_count == 0))
 740                                 ii->ii_hash_start = hash;
 741
 742                         if (ii->ii_flags & II_FL_VARREC)
 743                                 recsize = iops->rec_size(env, it, attr);
 744                         else
 745                                 recsize = ii->ii_recsize;
 746
 747                         entry = tmp_entry + recsize;
 748                         nob -= size;
 749                 }
 750
 751                 /* move on to the next record */
 752                 do {
 753                         rc = iops->next(env, it);
 754                 } while (rc == -ESTALE);
 755
 756         } while (rc == 0);
 757
 758         GOTO(out, rc);
 759 out:
 760         if (rc >= 0 && lip->lip_nr > 0)
 761                 /* one more container */
 762                 ii->ii_count++;
 763         if (rc > 0)
 764                 /* no more entries */
 765                 ii->ii_hash_end = II_END_OFF;
 766         return rc;
 767 }
 768
 769
 770 /*
 771  * Walk index and fill lu_page containers with key/record pairs
 772  *
 773  * \param env - is the environment passed by the caller
 774  * \param obj - is the index object to parse
 775  * \param rdpg - is the lu_rdpg descriptor associated with the transfer
 776  * \param filler - is the callback function responsible for filling a lu_page
 777  *                 with key/record pairs in the format wanted by the caller
 778  * \param arg    - is an opaq argument passed to the filler function
 779  *
 780  * \retval sum (in bytes) of all filled lu_pages
 781  * \retval -ve errno on failure
 782  */
 783 int dt_index_walk(const struct lu_env *env, struct dt_object *obj,
 784                   const struct lu_rdpg *rdpg, dt_index_page_build_t filler,
 785                   void *arg)
 786 {
 787         struct dt_it            *it;
 788         const struct dt_it_ops  *iops;
 789         unsigned int             pageidx, nob, nlupgs = 0;
 790         int                      rc;
 791         ENTRY;
 792
 793         LASSERT(rdpg->rp_pages != NULL);
 794         LASSERT(obj->do_index_ops != NULL);
 795
 796         nob = rdpg->rp_count;
 797         if (nob <= 0)
 798                 RETURN(-EFAULT);
 799
 800         /* Iterate through index and fill containers from @rdpg */
 801         iops = &obj->do_index_ops->dio_it;
 802         LASSERT(iops != NULL);
 803         it = iops->init(env, obj, rdpg->rp_attrs, BYPASS_CAPA);
 804         if (IS_ERR(it))
 805                 RETURN(PTR_ERR(it));
 806
 807         rc = iops->load(env, it, rdpg->rp_hash);
 808         if (rc == 0) {
 809                 /*
 810                  * Iterator didn't find record with exactly the key requested.
 811                  *
 812                  * It is currently either
 813                  *
 814                  *     - positioned above record with key less than
 815                  *     requested---skip it.
 816                  *     - or not positioned at all (is in IAM_IT_SKEWED
 817                  *     state)---position it on the next item.
 818                  */
 819                 rc = iops->next(env, it);
 820         } else if (rc > 0) {
 821                 rc = 0;
 822         } else {
 823                 if (rc == -ENODATA)
 824                         rc = 0;
 825                 GOTO(out, rc);
 826         }
 827
 828         /* Fill containers one after the other. There might be multiple
 829          * containers per physical page.
 830          *
 831          * At this point and across for-loop:
 832          *  rc == 0 -> ok, proceed.
 833          *  rc >  0 -> end of index.
 834          *  rc <  0 -> error. */
 835         for (pageidx = 0; rc == 0 && nob > 0; pageidx++) {
 836                 union lu_page   *lp;
 837                 int              i;
 838
 839                 LASSERT(pageidx < rdpg->rp_npages);
 840                 lp = kmap(rdpg->rp_pages[pageidx]);
 841
 842                 /* fill lu pages */
 843                 for (i = 0; i < LU_PAGE_COUNT; i++, lp++, nob -= LU_PAGE_SIZE) {
 844                         rc = filler(env, lp, min_t(int, nob, LU_PAGE_SIZE),
 845                                     iops, it, rdpg->rp_attrs, arg);
 846                         if (rc < 0)
 847                                 break;
 848                         /* one more lu_page */
 849                         nlupgs++;
 850                         if (rc > 0)
 851                                 /* end of index */
 852                                 break;
 853                 }
 854                 kunmap(rdpg->rp_pages[i]);
 855         }
 856
 857 out:
 858         iops->put(env, it);
 859         iops->fini(env, it);
 860
 861         if (rc >= 0)
 862                 rc = min_t(unsigned int, nlupgs * LU_PAGE_SIZE, rdpg->rp_count);
 863
 864         RETURN(rc);
 865 }
 866 EXPORT_SYMBOL(dt_index_walk);
 867
 868 /**
 869  * Walk key/record pairs of an index and copy them into 4KB containers to be
 870  * transferred over the network. This is the common handler for OBD_IDX_READ
 871  * RPC processing.
 872  *
 873  * \param env - is the environment passed by the caller
 874  * \param dev - is the dt_device storing the index
 875  * \param ii  - is the idx_info structure packed by the client in the
 876  *              OBD_IDX_READ request
 877  * \param rdpg - is the lu_rdpg descriptor
 878  *
 879  * \retval on success, return sum (in bytes) of all filled containers
 880  * \retval appropriate error otherwise.
 881  */
 882 int dt_index_read(const struct lu_env *env, struct dt_device *dev,
 883                   struct idx_info *ii, const struct lu_rdpg *rdpg)
 884 {
 885         const struct dt_index_features  *feat;
 886         struct dt_object                *obj;
 887         int                              rc;
 888         ENTRY;
 889
 890         /* rp_count shouldn't be null and should be a multiple of the container
 891          * size */
 892         if (rdpg->rp_count <= 0 && (rdpg->rp_count & (LU_PAGE_SIZE - 1)) != 0)
 893                 RETURN(-EFAULT);
 894
 895         if (!fid_is_quota(&ii->ii_fid) && !fid_is_layout_rbtree(&ii->ii_fid) &&
 896             !fid_is_norm(&ii->ii_fid))
 897                 RETURN(-EOPNOTSUPP);
 898
 899         /* lookup index object subject to the transfer */
 900         obj = dt_locate(env, dev, &ii->ii_fid);
 901         if (IS_ERR(obj))
 902                 RETURN(PTR_ERR(obj));
 903         if (dt_object_exists(obj) == 0)
 904                 GOTO(out, rc = -ENOENT);
 905
 906         /* fetch index features associated with index object */
 907         feat = dt_index_feat_select(fid_seq(&ii->ii_fid),
 908                                     lu_object_attr(&obj->do_lu));
 909         if (IS_ERR(feat))
 910                 GOTO(out, rc = PTR_ERR(feat));
 911
 912         /* load index feature if not done already */
 913         if (obj->do_index_ops == NULL) {
 914                 rc = obj->do_ops->do_index_try(env, obj, feat);
 915                 if (rc)
 916                         GOTO(out, rc);
 917         }
 918
 919         /* fill ii_flags with supported index features */
 920         ii->ii_flags &= (II_FL_NOHASH | II_FL_NOKEY | II_FL_VARKEY |
 921                          II_FL_VARREC);
 922
 923         if (!(feat->dif_flags & DT_IND_VARKEY))
 924                 ii->ii_keysize = feat->dif_keysize_max;
 925
 926         if (!(feat->dif_flags & DT_IND_VARREC))
 927                 ii->ii_recsize = feat->dif_recsize_max;
 928
 929         if (!(feat->dif_flags & DT_IND_NONUNQ))
 930                 /* key isn't necessarily unique */
 931                 ii->ii_flags |= II_FL_NONUNQ;
 932
 933         if (!fid_is_layout_rbtree(&ii->ii_fid)) {
 934                 dt_read_lock(env, obj, 0);
 935                 /* fetch object version before walking the index */
 936                 ii->ii_version = dt_version_get(env, obj);
 937         }
 938
 939         /* walk the index and fill lu_idxpages with key/record pairs */
 940         rc = dt_index_walk(env, obj, rdpg, dt_index_page_build, ii);
 941         if (!fid_is_layout_rbtree(&ii->ii_fid))
 942                 dt_read_unlock(env, obj);
 943
 944         if (rc == 0) {
 945                 /* index is empty */
 946                 LASSERT(ii->ii_count == 0);
 947                 ii->ii_hash_end = II_END_OFF;
 948         }
 949
 950         GOTO(out, rc);
 951 out:
 952         lu_object_put(env, &obj->do_lu);
 953         return rc;
 954 }
 955 EXPORT_SYMBOL(dt_index_read);
 956
 957 #ifdef LPROCFS
 958 int lprocfs_dt_blksize_seq_show(struct seq_file *m, void *v)
 959 {
 960         struct dt_device *dt = m->private;
 961         struct obd_statfs osfs;
 962
 963         int rc = dt_statfs(NULL, dt, &osfs);
 964         if (rc == 0)
 965                 seq_printf(m, "%u\n", (unsigned) osfs.os_bsize);
 966         return rc;
 967 }
 968 EXPORT_SYMBOL(lprocfs_dt_blksize_seq_show);
 969
 970 int lprocfs_dt_kbytestotal_seq_show(struct seq_file *m, void *v)
 971 {
 972         struct dt_device *dt = m->private;
 973         struct obd_statfs osfs;
 974
 975         int rc = dt_statfs(NULL, dt, &osfs);
 976         if (rc == 0) {
 977                 __u32 blk_size = osfs.os_bsize >> 10;
 978                 __u64 result = osfs.os_blocks;
 979
 980                 while (blk_size >>= 1)
 981                         result <<= 1;
 982
 983                 seq_printf(m, LPU64"\n", result);
 984         }
 985         return rc;
 986 }
 987 EXPORT_SYMBOL(lprocfs_dt_kbytestotal_seq_show);
 988
 989 int lprocfs_dt_kbytesfree_seq_show(struct seq_file *m, void *v)
 990 {
 991         struct dt_device *dt = m->private;
 992         struct obd_statfs osfs;
 993
 994         int rc = dt_statfs(NULL, dt, &osfs);
 995         if (rc == 0) {
 996                 __u32 blk_size = osfs.os_bsize >> 10;
 997                 __u64 result = osfs.os_bfree;
 998
 999                 while (blk_size >>= 1)
1000                         result <<= 1;
1001
1002                 seq_printf(m, LPU64"\n", result);
1003         }
1004         return rc;
1005 }
1006 EXPORT_SYMBOL(lprocfs_dt_kbytesfree_seq_show);
1007
1008 int lprocfs_dt_kbytesavail_seq_show(struct seq_file *m, void *v)
1009 {
1010         struct dt_device *dt = m->private;
1011         struct obd_statfs osfs;
1012
1013         int rc = dt_statfs(NULL, dt, &osfs);
1014         if (rc == 0) {
1015                 __u32 blk_size = osfs.os_bsize >> 10;
1016                 __u64 result = osfs.os_bavail;
1017
1018                 while (blk_size >>= 1)
1019                         result <<= 1;
1020
1021                 seq_printf(m, LPU64"\n", result);
1022         }
1023         return rc;
1024 }
1025 EXPORT_SYMBOL(lprocfs_dt_kbytesavail_seq_show);
1026
1027 int lprocfs_dt_filestotal_seq_show(struct seq_file *m, void *v)
1028 {
1029         struct dt_device *dt = m->private;
1030         struct obd_statfs osfs;
1031
1032         int rc = dt_statfs(NULL, dt, &osfs);
1033         if (rc == 0)
1034                 seq_printf(m, LPU64"\n", osfs.os_files);
1035         return rc;
1036 }
1037 EXPORT_SYMBOL(lprocfs_dt_filestotal_seq_show);
1038
1039 int lprocfs_dt_filesfree_seq_show(struct seq_file *m, void *v)
1040 {
1041         struct dt_device *dt = m->private;
1042         struct obd_statfs osfs;
1043
1044         int rc = dt_statfs(NULL, dt, &osfs);
1045         if (rc == 0)
1046                 seq_printf(m, LPU64"\n", osfs.os_ffree);
1047         return rc;
1048 }
1049 EXPORT_SYMBOL(lprocfs_dt_filesfree_seq_show);
1050
1051 #endif /* LPROCFS */