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