lustre/osd-zfs/osd_internal.h

   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) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, 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/osd-zfs/osd_internal.h
  33  * Shared definitions and declarations for zfs/dmu osd
  34  *
  35  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
  36  * Author: Mike Pershin <tappro@whamcloud.com>
  37  * Author: Johann Lombardi <johann@whamcloud.com>
  38  */
  39
  40 #ifndef _OSD_INTERNAL_H
  41 #define _OSD_INTERNAL_H
  42
  43 #include <dt_object.h>
  44 #include <md_object.h>
  45 #include <lustre_quota.h>
  46 #include <lustre_scrub.h>
  47 #include <obd.h>
  48 #ifdef SHRINK_STOP
  49 #undef SHRINK_STOP
  50 #endif
  51 #include <sys/arc.h>
  52 #include <sys/nvpair.h>
  53 #include <sys/zfs_znode.h>
  54 #include <sys/zap.h>
  55 #include <sys/dbuf.h>
  56 #include <sys/dmu_objset.h>
  57 #include <lustre_scrub.h>
  58
  59 /**
  60  * By design including kmem.h overrides the Linux slab interfaces to provide
  61  * the Illumos kmem cache interfaces.  To override this and gain access to
  62  * the Linux interfaces these preprocessor macros must be undefined.
  63  */
  64 #ifdef kmem_cache_destroy
  65 #undef kmem_cache_destroy
  66 #endif
  67
  68 #ifdef kmem_cache_create
  69 #undef kmem_cache_create
  70 #endif
  71
  72 #ifdef kmem_cache_alloc
  73 #undef kmem_cache_alloc
  74 #endif
  75
  76 #ifdef kmem_cache_free
  77 #undef kmem_cache_free
  78 #endif
  79
  80 #define ZFS_VERSION_CODE        \
  81         OBD_OCD_VERSION(ZFS_MAJOR, ZFS_MINOR, ZFS_PATCH, ZFS_FIX)
  82
  83 #define LUSTRE_ROOT_FID_SEQ     0
  84 #define DMU_OSD_SVNAME          "svname"
  85 #define DMU_OSD_OI_NAME_BASE    "oi"
  86
  87 #define OSD_GFP_IO              (GFP_NOFS | __GFP_HIGHMEM)
  88
  89 /* Statfs space reservation for grant, fragmentation, and unlink space. */
  90 #define OSD_STATFS_RESERVED_SIZE        (16ULL << 20) /* reserve 16MB minimum */
  91 #define OSD_STATFS_RESERVED_SHIFT       (7)     /* reserve 0.78% of all space */
  92
  93 /* Statfs {minimum, safe estimate, and maximum} dnodes per block */
  94 #define OSD_DNODE_MIN_BLKSHIFT  (DNODES_PER_BLOCK_SHIFT)
  95 #define OSD_DNODE_EST_BLKSHIFT  (12)     /* est 4KB/dnode */
  96 #define OSD_DNODE_EST_COUNT     4096
  97
  98 #define OSD_GRANT_FOR_LOCAL_OIDS (2ULL << 20) /* 2MB for last_rcvd, ... */
  99
 100 /**
 101  * Iterator's in-memory data structure for quota file.
 102  */
 103 struct osd_it_quota {
 104         struct osd_object       *oiq_obj;
 105         /* DMU accounting object id */
 106         uint64_t                 oiq_oid;
 107         /* ZAP cursor */
 108         zap_cursor_t            *oiq_zc;
 109         /** identifier for current quota record */
 110         __u64                    oiq_id;
 111         unsigned                 oiq_reset:1; /* 1 -- no need to advance */
 112 };
 113
 114 /**
 115  * Iterator's in-memory data structure for ZAPs
 116  *
 117  * ZFS does not store . and .. on a disk, instead they are
 118  * generated up on request
 119  * to follow this format we do the same
 120  */
 121 struct osd_zap_it {
 122         zap_cursor_t            *ozi_zc;
 123         struct osd_object       *ozi_obj;
 124         unsigned                 ozi_reset:1;   /* 1 -- no need to advance */
 125         /* ozi_pos - position of the cursor:
 126          * 0 - before any record
 127          * 1 - "."
 128          * 2 - ".."
 129          * 3 - real records */
 130         unsigned                 ozi_pos:3;
 131         union {
 132                 char             ozi_name[MAXNAMELEN]; /* file name for dir */
 133                 __u64            ozi_key; /* binary key for index files */
 134         };
 135 };
 136 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
 137
 138 /*
 139  * regular ZFS direntry
 140  */
 141 struct zpl_direntry {
 142         uint64_t        zde_dnode:48,
 143                         zde_pad:12,
 144                         zde_type:4;
 145 } __attribute__((packed));
 146
 147 /*
 148  * lustre direntry adds a fid to regular ZFS direntry
 149  */
 150 struct luz_direntry {
 151         struct zpl_direntry     lzd_reg;
 152         struct lu_fid           lzd_fid;
 153 } __attribute__((packed));
 154
 155
 156 /* cached SA attributes */
 157 struct osa_attr {
 158         uint64_t        mode;
 159         uint64_t        gid;
 160         uint64_t        uid;
 161 #ifdef ZFS_PROJINHERIT
 162         uint64_t        projid;
 163 #endif
 164         uint64_t        nlink;
 165         uint64_t        rdev;
 166         uint64_t        flags;
 167         uint64_t        size;
 168         uint64_t        atime[2];
 169         uint64_t        mtime[2];
 170         uint64_t        ctime[2];
 171 };
 172
 173
 174 #define OSD_INS_CACHE_SIZE      8
 175
 176 /* OI cache entry */
 177 struct osd_idmap_cache {
 178         struct osd_device       *oic_dev;
 179         struct lu_fid           oic_fid;
 180         /** max 2^48 dnodes per dataset, avoid spilling into another word */
 181         uint64_t                oic_dnode:DN_MAX_OBJECT_SHIFT,
 182                                 oic_remote:1;      /* FID isn't local */
 183 };
 184
 185 struct osd_inconsistent_item {
 186         /* link into lustre_scrub::os_inconsistent_items,
 187          * protected by lustr_scrub::os_lock. */
 188         struct list_head       oii_list;
 189
 190         /* The right FID <=> oid mapping. */
 191         struct osd_idmap_cache oii_cache;
 192
 193         unsigned int           oii_insert:1; /* insert or update mapping. */
 194 };
 195
 196 struct osd_otable_it {
 197         struct osd_device       *ooi_dev;
 198         struct lu_fid            ooi_fid;
 199         __u64                    ooi_pos;
 200         __u64                    ooi_prefetched_dnode;
 201         int                      ooi_prefetched;
 202
 203         /* The following bits can be updated/checked w/o lock protection.
 204          * If more bits will be introduced in the future and need lock to
 205          * protect, please add comment. */
 206         unsigned int             ooi_used_outside:1, /* Some user out of OSD
 207                                                       * uses the iteration. */
 208                                  ooi_all_cached:1, /* No more entries can be
 209                                                     * filled into cache. */
 210                                  ooi_user_ready:1, /* The user out of OSD is
 211                                                     * ready to iterate. */
 212                                  ooi_waiting:1; /* it::next is waiting. */
 213 };
 214
 215 extern const struct dt_index_operations osd_otable_ops;
 216
 217 /* max.number of regular attributes the callers may ask for */
 218 # define OSD_MAX_IN_BULK (sizeof(struct osa_attr)/sizeof(uint64_t))
 219
 220 struct osd_thread_info {
 221         const struct lu_env     *oti_env;
 222
 223         struct lu_fid            oti_fid;
 224         /*
 225          * XXX temporary: for ->i_op calls.
 226          */
 227         struct timespec          oti_time;
 228
 229         struct ost_id            oti_ostid;
 230
 231         char                     oti_buf[64];
 232
 233         char                     oti_str[64];
 234         union {
 235                 char             oti_key[MAXNAMELEN + 1];
 236                 __u64            oti_key64[(MAXNAMELEN + 1)/sizeof(__u64)];
 237                 sa_bulk_attr_t   oti_attr_bulk[OSD_MAX_IN_BULK];
 238         };
 239         struct lustre_mdt_attrs  oti_mdt_attrs;
 240         unsigned int             oti_in_trans:1;
 241
 242         struct lu_attr           oti_la;
 243         struct osa_attr          oti_osa;
 244         zap_attribute_t          oti_za;
 245         zap_attribute_t          oti_za2;
 246         dmu_object_info_t        oti_doi;
 247         struct luz_direntry      oti_zde;
 248
 249         struct lquota_id_info    oti_qi;
 250         struct lu_seq_range      oti_seq_range;
 251
 252         /* dedicated OI cache for insert (which needs inum) */
 253         struct osd_idmap_cache *oti_ins_cache;
 254         int                    oti_ins_cache_size;
 255         int                    oti_ins_cache_used;
 256         struct lu_buf          oti_xattr_lbuf;
 257         zap_cursor_t           oti_zc;
 258         zap_cursor_t           oti_zc2;
 259 };
 260
 261 extern struct lu_context_key osd_key;
 262
 263 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
 264 {
 265         return lu_context_key_get(&env->le_ctx, &osd_key);
 266 }
 267
 268 struct osd_thandle {
 269         struct thandle           ot_super;
 270         struct list_head         ot_dcb_list;
 271         struct list_head         ot_stop_dcb_list;
 272         struct list_head         ot_unlinked_list;
 273         struct list_head         ot_sa_list;
 274         dmu_tx_t                *ot_tx;
 275         struct lquota_trans      ot_quota_trans;
 276         __u32                    ot_write_commit:1,
 277                                  ot_assigned:1;
 278 };
 279
 280 #define OSD_OI_NAME_SIZE        24
 281
 282 /*
 283  * Object Index (OI) instance.
 284  */
 285 struct osd_oi {
 286         char                    oi_name[OSD_OI_NAME_SIZE];
 287         uint64_t                oi_zapid;
 288         dnode_t *oi_dn;
 289 };
 290
 291 struct osd_seq {
 292         uint64_t         os_oid;
 293         uint64_t         *os_compat_dirs;
 294         int              os_subdir_count; /* subdir count for each seq */
 295         u64              os_seq;          /* seq number */
 296         struct list_head os_seq_list;     /* list to seq_list */
 297 };
 298
 299 struct osd_seq_list {
 300         rwlock_t         osl_seq_list_lock;     /* lock for seq_list */
 301         struct list_head osl_seq_list;          /* list head for seq */
 302         struct semaphore osl_seq_init_sem;
 303 };
 304
 305 #define OSD_OST_MAP_SIZE        32
 306
 307 /*
 308  * osd device.
 309  */
 310 struct osd_device {
 311         /* super-class */
 312         struct dt_device         od_dt_dev;
 313         /* information about underlying file system */
 314         struct objset           *od_os;
 315         uint64_t                 od_rootid;  /* id of root znode */
 316         dnode_t *od_unlinked; /* dnode of unlinked zapobj */
 317         /* SA attr mapping->id,
 318          * name is the same as in ZFS to use defines SA_ZPL_...*/
 319         sa_attr_type_t           *z_attr_table;
 320
 321         struct proc_dir_entry   *od_proc_entry;
 322         struct lprocfs_stats    *od_stats;
 323
 324         uint64_t                 od_remote_parent_dir;
 325         uint64_t                 od_index_backup_id;
 326         uint64_t                 od_max_blksz;
 327         uint64_t                 od_root;
 328         uint64_t                 od_O_id;
 329         struct osd_oi           **od_oi_table;
 330         unsigned int             od_oi_count;
 331         struct osd_seq_list     od_seq_list;
 332
 333         unsigned int             od_dev_set_rdonly:1, /**< osd_ro() called */
 334                                  od_prop_rdonly:1,  /**< ZFS property readonly */
 335                                  od_xattr_in_sa:1,
 336                                  od_is_ost:1,
 337                                  od_in_init:1,
 338                                  od_posix_acl:1;
 339         unsigned int             od_dnsize;
 340         int                      od_index_backup_stop;
 341
 342         enum lustre_index_backup_policy od_index_backup_policy;
 343         char                     od_mntdev[128];
 344         char                     od_svname[128];
 345         char                     od_uuid[16];
 346
 347         int                      od_connects;
 348         int                      od_index;
 349         __s64                    od_auto_scrub_interval;
 350         struct lu_site           od_site;
 351
 352         dnode_t                 *od_groupused_dn;
 353         dnode_t                 *od_userused_dn;
 354 #ifdef ZFS_PROJINHERIT
 355         dnode_t                 *od_projectused_dn;
 356 #endif
 357
 358         /* quota slave instance */
 359         struct qsd_instance     *od_quota_slave;
 360
 361         struct brw_stats        od_brw_stats;
 362         atomic_t                od_r_in_flight;
 363         atomic_t                od_w_in_flight;
 364
 365         /* used to debug zerocopy logic: the fields track all
 366          * allocated, loaned and referenced buffers in use.
 367          * to be removed once the change is tested well. */
 368         atomic_t                 od_zerocopy_alloc;
 369         atomic_t                 od_zerocopy_loan;
 370         atomic_t                 od_zerocopy_pin;
 371
 372         arc_prune_t             *arc_prune_cb;
 373
 374         /* osd seq instance */
 375         struct lu_client_seq    *od_cl_seq;
 376
 377         struct semaphore         od_otable_sem;
 378         struct osd_otable_it    *od_otable_it;
 379         struct lustre_scrub      od_scrub;
 380         struct list_head         od_ios_list;
 381         struct list_head         od_index_backup_list;
 382         struct list_head         od_index_restore_list;
 383         spinlock_t               od_lock;
 384 };
 385
 386 enum osd_destroy_type {
 387         OSD_DESTROY_NONE = 0,
 388         OSD_DESTROY_SYNC = 1,
 389         OSD_DESTROY_ASYNC = 2,
 390 };
 391
 392 struct osd_object {
 393         struct dt_object         oo_dt;
 394         /*
 395          * Inode for file system object represented by this osd_object. This
 396          * inode is pinned for the whole duration of lu_object life.
 397          *
 398          * Not modified concurrently (either setup early during object
 399          * creation, or assigned by osd_create() under write lock).
 400          */
 401         dnode_t *oo_dn;
 402         sa_handle_t             *oo_sa_hdl;
 403         nvlist_t                *oo_sa_xattr;
 404         struct list_head         oo_sa_linkage;
 405
 406         /* used to implement osd_object_*_{lock|unlock} */
 407         struct rw_semaphore      oo_sem;
 408
 409         /* to serialize some updates: destroy vs. others,
 410          * xattr_set, object block size change etc */
 411         struct rw_semaphore      oo_guard;
 412
 413         /* protected by oo_guard */
 414         struct list_head         oo_unlinked_linkage;
 415
 416         /* cached attributes */
 417         rwlock_t                 oo_attr_lock;
 418         struct lu_attr           oo_attr;
 419
 420         /* external dnode holding large EAs, protected by oo_guard */
 421         uint64_t                 oo_xattr;
 422         enum osd_destroy_type    oo_destroy;
 423
 424         __u32                    oo_destroyed:1,
 425                                  oo_late_xattr:1,
 426 #ifdef ZFS_PROJINHERIT
 427                                  oo_with_projid:1,
 428 #endif
 429                                  oo_late_attr_set:1,
 430                                  oo_pfid_in_lma:1;
 431
 432         /* the i_flags in LMA */
 433         __u32                    oo_lma_flags;
 434         union {
 435                 int             oo_ea_in_bonus; /* EA bytes we expect */
 436                 struct {
 437                         /* record size for index file */
 438                         unsigned char            oo_keysize;
 439                         unsigned char            oo_recsize;
 440                         unsigned char            oo_recusize;   /* unit size */
 441                 };
 442                 uint64_t        oo_parent; /* used only at object creation */
 443         };
 444         struct lu_object_header *oo_header;
 445 };
 446
 447 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
 448 extern const struct dt_index_operations osd_acct_index_ops;
 449 extern struct lu_device_operations  osd_lu_ops;
 450 extern struct dt_index_operations osd_dir_ops;
 451 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
 452                       qid_t uid, qid_t gid, qid_t projid, long long space,
 453                       struct osd_thandle *oh, int *flags,
 454                       enum osd_qid_declare_flags osd_qid_declare_flags);
 455 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
 456                                  uint64_t nrblocks, uint64_t est_maxblockshift);
 457 int osd_unlinked_object_free(const struct lu_env *env, struct osd_device *osd,
 458                          uint64_t oid);
 459
 460 /*
 461  * Helpers.
 462  */
 463 static inline int lu_device_is_osd(const struct lu_device *d)
 464 {
 465         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 466 }
 467
 468 static inline struct osd_object *osd_obj(const struct lu_object *o)
 469 {
 470         LASSERT(lu_device_is_osd(o->lo_dev));
 471         return container_of0(o, struct osd_object, oo_dt.do_lu);
 472 }
 473
 474 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 475 {
 476         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 477         return container_of0(d, struct osd_device, od_dt_dev);
 478 }
 479
 480 static inline struct osd_device *osd_dev(const struct lu_device *d)
 481 {
 482         LASSERT(lu_device_is_osd(d));
 483         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 484 }
 485
 486 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 487 {
 488         return osd_obj(&d->do_lu);
 489 }
 490
 491 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 492 {
 493         return osd_dev(o->oo_dt.do_lu.lo_dev);
 494 }
 495
 496 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 497 {
 498         return &osd->od_dt_dev.dd_lu_dev;
 499 }
 500
 501 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
 502 {
 503         return osd_dev(o->do_lu.lo_dev)->od_os;
 504 }
 505
 506 static inline int osd_invariant(const struct osd_object *obj)
 507 {
 508         return 1;
 509 }
 510
 511 /**
 512  * Put the osd object once done with it.
 513  *
 514  * \param obj osd object that needs to be put
 515  */
 516 static inline void osd_object_put(const struct lu_env *env,
 517                                   struct osd_object *obj)
 518 {
 519         dt_object_put(env, &obj->oo_dt);
 520 }
 521
 522 static inline int osd_object_invariant(const struct lu_object *l)
 523 {
 524         return osd_invariant(osd_obj(l));
 525 }
 526
 527 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
 528 {
 529         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 530 }
 531
 532 static inline char *osd_name(struct osd_device *osd)
 533 {
 534         return osd->od_svname;
 535 }
 536
 537 static inline void zfs_set_bit(int nr, __u8 *addr)
 538 {
 539         set_bit(nr, (unsigned long *)addr);
 540 }
 541
 542 static inline int zfs_test_bit(int nr, __u8 *addr)
 543 {
 544         return test_bit(nr, (const unsigned long *)addr);
 545 }
 546
 547 static inline int osd_oi_fid2idx(struct osd_device *dev,
 548                                  const struct lu_fid *fid)
 549 {
 550         return fid->f_seq & (dev->od_oi_count - 1);
 551 }
 552
 553 static inline struct osd_oi *osd_fid2oi(struct osd_device *osd,
 554                                         const struct lu_fid *fid)
 555 {
 556         LASSERTF(osd->od_oi_table && osd->od_oi_count >= 1,
 557                  "%s: "DFID", oi_count %d\n",
 558                  osd_name(osd), PFID(fid), osd->od_oi_count);
 559
 560         return osd->od_oi_table[osd_oi_fid2idx(osd, fid)];
 561 }
 562
 563 #ifdef CONFIG_PROC_FS
 564 enum {
 565         LPROC_OSD_READ_BYTES = 0,
 566         LPROC_OSD_WRITE_BYTES = 1,
 567         LPROC_OSD_GET_PAGE = 2,
 568         LPROC_OSD_NO_PAGE = 3,
 569         LPROC_OSD_CACHE_ACCESS = 4,
 570         LPROC_OSD_CACHE_HIT = 5,
 571         LPROC_OSD_CACHE_MISS = 6,
 572         LPROC_OSD_COPY_IO = 7,
 573         LPROC_OSD_ZEROCOPY_IO = 8,
 574         LPROC_OSD_TAIL_IO = 9,
 575         LPROC_OSD_LAST,
 576 };
 577
 578 extern struct kmem_cache *osd_zapit_cachep;
 579 /* osd_lproc.c */
 580 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
 581
 582 int osd_procfs_init(struct osd_device *osd, const char *name);
 583 int osd_procfs_fini(struct osd_device *osd);
 584
 585 /* osd_object.c */
 586 extern char *osd_obj_tag;
 587 int __osd_obj2dnode(objset_t *os, uint64_t oid, dnode_t **dnp);
 588 void osd_object_sa_dirty_rele(const struct lu_env *env, struct osd_thandle *oh);
 589 void osd_object_sa_dirty_add(struct osd_object *obj, struct osd_thandle *oh);
 590 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
 591                    uint64_t oid, dmu_buf_t **dbp);
 592 struct lu_object *osd_object_alloc(const struct lu_env *env,
 593                                    const struct lu_object_header *hdr,
 594                                    struct lu_device *d);
 595 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
 596                          void *buf, uint32_t buflen, struct osd_thandle *oh);
 597 int __osd_zap_create(const struct lu_env *env, struct osd_device *osd,
 598                      dnode_t **zap_dnp, dmu_tx_t *tx, struct lu_attr *la,
 599                      unsigned dnsize, zap_flags_t flags);
 600 int __osd_object_create(const struct lu_env *env, struct osd_device *osd,
 601                         struct osd_object *obj, const struct lu_fid *fid,
 602                         dnode_t **dnp, dmu_tx_t *tx, struct lu_attr *la);
 603 int __osd_attr_init(const struct lu_env *env, struct osd_device *osd,
 604                     struct osd_object *obj, sa_handle_t *sa_hdl, dmu_tx_t *tx,
 605                     struct lu_attr *la, uint64_t parent, nvlist_t *);
 606 int osd_find_new_dnode(const struct lu_env *env, dmu_tx_t *tx,
 607                        uint64_t oid, dnode_t **dnp);
 608 int osd_object_init0(const struct lu_env *env, struct osd_object *obj);
 609
 610 /* osd_oi.c */
 611 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
 612 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
 613 int osd_fid_lookup(const struct lu_env *env,
 614                    struct osd_device *, const struct lu_fid *, uint64_t *);
 615 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
 616                             const struct lu_fid *fid, char *buf, int bufsize,
 617                             dnode_t **zdn);
 618 int osd_options_init(void);
 619 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
 620                        __u64 seq);
 621 int osd_idc_find_and_init(const struct lu_env *env, struct osd_device *osd,
 622                           struct osd_object *obj);
 623 struct osd_idmap_cache *osd_idc_find_or_init(const struct lu_env *env,
 624                                              struct osd_device *osd,
 625                                              const struct lu_fid *fid);
 626 struct osd_idmap_cache *osd_idc_find(const struct lu_env *env,
 627                                      struct osd_device *osd,
 628                                      const struct lu_fid *fid);
 629 int osd_idc_find_and_init_with_oid(const struct lu_env *env,
 630                                    struct osd_device *osd,
 631                                    const struct lu_fid *fid,
 632                                    uint64_t oid);
 633 int fid_is_on_ost(const struct lu_env *env, struct osd_device *osd,
 634                   const struct lu_fid *fid);
 635 int osd_obj_find_or_create(const struct lu_env *env, struct osd_device *o,
 636                            uint64_t parent, const char *name, uint64_t *child,
 637                            const struct lu_fid *fid, bool isdir);
 638
 639 extern unsigned int osd_oi_count;
 640
 641 /* osd_index.c */
 642 int osd_get_fid_by_oid(const struct lu_env *env, struct osd_device *osd,
 643                        uint64_t oid, struct lu_fid *fid);
 644 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
 645                   const struct dt_index_features *feat);
 646 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
 647                    u64 seq, struct lu_seq_range *range);
 648 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
 649                                     uint64_t id, uint64_t dirhash);
 650 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
 651                         uint64_t id, uint64_t dirhash);
 652 void osd_zap_cursor_fini(zap_cursor_t *zc);
 653 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc);
 654 int osd_remote_fid(const struct lu_env *env, struct osd_device *osd,
 655                    const struct lu_fid *fid);
 656 int osd_add_to_remote_parent(const struct lu_env *env,
 657                              struct osd_device *osd,
 658                              struct osd_object *obj,
 659                              struct osd_thandle *oh);
 660 int osd_delete_from_remote_parent(const struct lu_env *env,
 661                                   struct osd_device *osd,
 662                                   struct osd_object *obj,
 663                                   struct osd_thandle *oh, bool destroy);
 664 int __osd_xattr_load_by_oid(struct osd_device *osd, uint64_t oid,
 665                             nvlist_t **sa);
 666
 667 /* osd_scrub.c */
 668 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev);
 669 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev);
 670 int osd_scrub_start(const struct lu_env *env, struct osd_device *dev,
 671                     __u32 flags);
 672 int osd_oii_insert(const struct lu_env *env, struct osd_device *dev,
 673                    const struct lu_fid *fid, uint64_t oid, bool insert);
 674 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
 675                    uint64_t *oid);
 676
 677 /* osd_xattr.c */
 678 int __osd_sa_xattr_schedule_update(const struct lu_env *env,
 679                                    struct osd_object *obj,
 680                                    struct osd_thandle *oh);
 681 int __osd_sa_attr_init(const struct lu_env *env, struct osd_object *obj,
 682                        struct osd_thandle *oh);
 683 int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
 684                           struct osd_thandle *oh);
 685 int __osd_xattr_load(struct osd_device *osd, sa_handle_t *hdl,
 686                      nvlist_t **sa);
 687 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
 688                           uint64_t xattr, struct lu_buf *buf,
 689                           const char *name, int *sizep);
 690 int osd_xattr_get_internal(const struct lu_env *env, struct osd_object *obj,
 691                            struct lu_buf *buf, const char *name, int *sizep);
 692 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
 693                   struct lu_buf *buf, const char *name);
 694 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
 695                           const struct lu_buf *buf, const char *name,
 696                           int fl, struct thandle *handle);
 697 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
 698                   const struct lu_buf *buf, const char *name, int fl,
 699                   struct thandle *handle);
 700 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
 701                           const char *name, struct thandle *handle);
 702 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
 703                   const char *name, struct thandle *handle);
 704 void osd_declare_xattrs_destroy(const struct lu_env *env,
 705                                 struct osd_object *obj,
 706                                 struct osd_thandle *oh);
 707 int osd_xattrs_destroy(const struct lu_env *env,
 708                        struct osd_object *obj, struct osd_thandle *oh);
 709 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
 710                    const struct lu_buf *lb);
 711 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
 712                         int vallen, const char *name, struct osd_thandle *oh);
 713 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
 714                        const struct lu_buf *buf, const char *name, int fl,
 715                        struct osd_thandle *oh);;
 716 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
 717                     const struct lu_buf *buf, const char *name, int fl,
 718                     struct osd_thandle *oh);
 719 int __osd_sa_xattr_update(const struct lu_env *env, struct osd_object *obj,
 720                           struct osd_thandle *oh);
 721
 722 #define OSD_BASE_EA_IN_BONUS    (ZFS_SA_BASE_ATTR_SIZE + \
 723                                  sizeof(__u64) /* VBR VERSION */ + \
 724                                  sizeof(struct lustre_mdt_attrs) /* LMA */)
 725
 726 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
 727 int osd_find_dnsize(struct osd_device *osd, int ea_in_bonus);
 728 #else
 729 static inline int
 730 osd_find_dnsize(struct osd_device *osd, int ea_in_bonus)
 731 {
 732         return DN_MAX_BONUSLEN;
 733 }
 734 #endif
 735
 736 static inline int osd_object_is_zap(dnode_t *dn)
 737 {
 738         return (dn->dn_type == DMU_OT_DIRECTORY_CONTENTS ||
 739                 dn->dn_type == DMU_OT_USERGROUP_USED);
 740 }
 741
 742 /* XXX: f_ver is not counted, but may differ too */
 743 static inline void osd_fid2str(char *buf, const struct lu_fid *fid, int len)
 744 {
 745         snprintf(buf, len, DFID_NOBRACE, PFID(fid));
 746 }
 747
 748 static inline int
 749 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
 750                        const struct lu_buf *buf, const char *name, int fl,
 751                        struct osd_thandle *oh)
 752 {
 753         int rc;
 754
 755         if (unlikely(!dt_object_exists(&obj->oo_dt) || obj->oo_destroyed))
 756                 return -ENOENT;
 757
 758         LASSERT(obj->oo_dn);
 759         if (osd_obj2dev(obj)->od_xattr_in_sa) {
 760                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
 761                 if (rc == -EFBIG)
 762                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
 763         } else {
 764                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
 765         }
 766
 767         return rc;
 768 }
 769
 770 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
 771 {
 772         return (flags & LUSTRE_APPEND_FL        ? ZFS_APPENDONLY        : 0) |
 773                 (flags & LUSTRE_NODUMP_FL       ? ZFS_NODUMP            : 0) |
 774 #ifdef ZFS_PROJINHERIT
 775                 (flags & LUSTRE_PROJINHERIT_FL  ? ZFS_PROJINHERIT       : 0) |
 776 #endif
 777                 (flags & LUSTRE_IMMUTABLE_FL    ? ZFS_IMMUTABLE         : 0);
 778 }
 779
 780 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
 781 {
 782         return (flags & ZFS_APPENDONLY  ? LUSTRE_APPEND_FL      : 0) |
 783                 (flags & ZFS_NODUMP     ? LUSTRE_NODUMP_FL      : 0) |
 784 #ifdef ZFS_PROJINHERIT
 785                 (flags & ZFS_PROJINHERIT ? LUSTRE_PROJINHERIT_FL : 0) |
 786 #endif
 787                 (flags & ZFS_IMMUTABLE  ? LUSTRE_IMMUTABLE_FL   : 0);
 788 }
 789
 790 #endif
 791
 792 #ifndef HAVE_DSL_POOL_CONFIG
 793 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
 794 {
 795 }
 796
 797 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
 798 {
 799 }
 800 #endif
 801
 802 #ifdef HAVE_SPA_MAXBLOCKSIZE
 803 #define osd_spa_maxblocksize(spa)       spa_maxblocksize(spa)
 804 #define osd_spa_maxblockshift(spa)      fls64(spa_maxblocksize(spa) - 1)
 805 #else
 806 #define osd_spa_maxblocksize(spa)       SPA_MAXBLOCKSIZE
 807 #define osd_spa_maxblockshift(spa)      SPA_MAXBLOCKSHIFT
 808 #define SPA_OLD_MAXBLOCKSIZE            SPA_MAXBLOCKSIZE
 809 #endif
 810
 811 #ifdef HAVE_SA_SPILL_ALLOC
 812 static inline void *
 813 osd_zio_buf_alloc(size_t size)
 814 {
 815         return sa_spill_alloc(KM_SLEEP);
 816 }
 817
 818 static inline void
 819 osd_zio_buf_free(void *buf, size_t size)
 820 {
 821         sa_spill_free(buf);
 822 }
 823 #else
 824 #define osd_zio_buf_alloc(size)         zio_buf_alloc(size)
 825 #define osd_zio_buf_free(buf, size)     zio_buf_free(buf, size)
 826 #endif
 827
 828 #ifdef HAVE_DMU_OBJECT_ALLOC_DNSIZE
 829 static inline uint64_t
 830 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
 831                      int dnodesize, dmu_tx_t *tx)
 832 {
 833         if (dnodesize == 0)
 834                 dnodesize = MAX(dmu_objset_dnodesize(os), DNODE_MIN_SIZE);
 835
 836         return dmu_object_alloc_dnsize(os, objtype, blocksize, DMU_OT_SA,
 837                                        DN_BONUS_SIZE(dnodesize), dnodesize, tx);
 838 }
 839
 840 static inline uint64_t
 841 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
 842                      dmu_object_type_t ot, int leaf_blockshift,
 843                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
 844 {
 845         if (dnodesize == 0)
 846                 dnodesize = MAX(dmu_objset_dnodesize(os), DNODE_MIN_SIZE);
 847
 848         return zap_create_flags_dnsize(os, normflags, flags, ot,
 849                                        leaf_blockshift, indirect_blockshift,
 850                                        DMU_OT_SA, DN_BONUS_SIZE(dnodesize),
 851                                        dnodesize, tx);
 852 }
 853
 854 static inline int
 855 osd_obj_bonuslen(struct osd_object *obj)
 856 {
 857         int bonuslen = DN_BONUS_SIZE(DNODE_MIN_SIZE);
 858
 859         if (obj->oo_dn != NULL && obj->oo_dn->dn_num_slots != 0) {
 860                 bonuslen = DN_SLOTS_TO_BONUSLEN(obj->oo_dn->dn_num_slots);
 861         } else {
 862                 objset_t *os = osd_dtobj2objset(&obj->oo_dt);
 863                 int dnodesize;
 864
 865                 if (os != NULL) {
 866                         dnodesize = dmu_objset_dnodesize(os);
 867                         if (dnodesize != 0)
 868                                 bonuslen = DN_BONUS_SIZE(dnodesize);
 869                 }
 870         }
 871
 872         return bonuslen;
 873 }
 874 #else
 875 static inline uint64_t
 876 osd_dmu_object_alloc(objset_t *os, dmu_object_type_t objtype, int blocksize,
 877                      int dnodesize, dmu_tx_t *tx)
 878 {
 879         return dmu_object_alloc(os, objtype, blocksize, DMU_OT_SA,
 880                                 DN_MAX_BONUSLEN, tx);
 881 }
 882
 883 static inline uint64_t
 884 osd_zap_create_flags(objset_t *os, int normflags, zap_flags_t flags,
 885                      dmu_object_type_t ot, int leaf_blockshift,
 886                      int indirect_blockshift, int dnodesize, dmu_tx_t *tx)
 887 {
 888         return zap_create_flags(os, normflags, flags, ot, leaf_blockshift,
 889                                 indirect_blockshift, DMU_OT_SA,
 890                                 DN_MAX_BONUSLEN, tx);
 891 }
 892
 893 static inline int
 894 osd_obj_bonuslen(struct osd_object *obj)
 895 {
 896         return DN_MAX_BONUSLEN;
 897 }
 898 #endif /* HAVE_DMU_OBJECT_ALLOC_DNSIZE */
 899
 900 #ifdef HAVE_DMU_PREFETCH_6ARG
 901 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
 902         dmu_prefetch((os), (obj), (lvl), (off), (len), (pri))
 903 #else
 904 #define osd_dmu_prefetch(os, obj, lvl, off, len, pri)   \
 905         dmu_prefetch((os), (obj), (lvl), (off))
 906 #endif
 907
 908 static inline int osd_sa_handle_get(struct osd_object *obj)
 909 {
 910         struct osd_device *osd = osd_obj2dev(obj);
 911         dnode_t *dn = obj->oo_dn;
 912         int rc;
 913
 914         if (obj->oo_sa_hdl)
 915                 return 0;
 916
 917         dbuf_read(dn->dn_bonus, NULL, DB_RF_MUST_SUCCEED | DB_RF_NOPREFETCH);
 918         rc = -sa_handle_get_from_db(osd->od_os, &dn->dn_bonus->db, obj,
 919                                     SA_HDL_PRIVATE, &obj->oo_sa_hdl);
 920         if (rc)
 921                 return rc;
 922         refcount_add(&dn->dn_bonus->db_holds, osd_obj_tag);
 923         return 0;
 924 }
 925
 926 static inline void osd_dnode_rele(dnode_t *dn)
 927 {
 928         dmu_buf_impl_t *db;
 929         LASSERT(dn);
 930         LASSERT(dn->dn_bonus);
 931         db = dn->dn_bonus;
 932
 933         DB_DNODE_EXIT(db);
 934         dmu_buf_rele(&db->db, osd_obj_tag);
 935 }
 936
 937 #ifdef HAVE_DMU_USEROBJ_ACCOUNTING
 938
 939 #define OSD_DMU_USEROBJ_PREFIX          DMU_OBJACCT_PREFIX
 940 #define OSD_DMU_USEROBJ_PREFIX_LEN      DMU_OBJACCT_PREFIX_LEN
 941
 942 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
 943 {
 944         return dmu_objset_userobjspace_present(osd->od_os);
 945 }
 946 #else
 947
 948 #define OSD_DMU_USEROBJ_PREFIX          "obj-"
 949 #define OSD_DMU_USEROBJ_PREFIX_LEN      4
 950
 951 static inline bool osd_dmu_userobj_accounting_available(struct osd_device *osd)
 952 {
 953         return false;
 954 }
 955 #endif /* #ifdef HAVE_DMU_USEROBJ_ACCOUNTING */
 956
 957 static inline int osd_zap_add(struct osd_device *osd, uint64_t zap,
 958                               dnode_t *dn, const char *key,
 959                               int int_size, int int_num,
 960                               const void *val, dmu_tx_t *tx)
 961 {
 962         LASSERT(zap != 0);
 963
 964 #ifdef HAVE_ZAP_ADD_BY_DNODE
 965         if (dn)
 966                 return -zap_add_by_dnode(dn, key, int_size, int_num, val, tx);
 967 #endif
 968         return -zap_add(osd->od_os, zap, key, int_size, int_num, val, tx);
 969 }
 970
 971 static inline int osd_zap_remove(struct osd_device *osd, uint64_t zap,
 972                                  dnode_t *dn, const char *key,
 973                                  dmu_tx_t *tx)
 974 {
 975         LASSERT(zap != 0);
 976
 977 #ifdef HAVE_ZAP_ADD_BY_DNODE
 978         if (dn)
 979                 return -zap_remove_by_dnode(dn, key, tx);
 980 #endif
 981         return -zap_remove(osd->od_os, zap, key, tx);
 982 }
 983
 984
 985 static inline int osd_zap_lookup(struct osd_device *osd, uint64_t zap,
 986                                  dnode_t *dn, const char *key,
 987                                  int int_size, int int_num, void *v)
 988 {
 989         LASSERT(zap != 0);
 990
 991 #ifdef HAVE_ZAP_ADD_BY_DNODE
 992         if (dn)
 993                 return -zap_lookup_by_dnode(dn, key, int_size, int_num, v);
 994 #endif
 995         return -zap_lookup(osd->od_os, zap, key, int_size, int_num, v);
 996 }
 997
 998 static inline void osd_tx_hold_zap(dmu_tx_t *tx, uint64_t zap,
 999                                    dnode_t *dn, int add, const char *name)
1000 {
1001 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1002         if (dn) {
1003                 dmu_tx_hold_zap_by_dnode(tx, dn, add, name);
1004                 return;
1005         }
1006 #endif
1007         dmu_tx_hold_zap(tx, zap, add, name);
1008 }
1009
1010 static inline void osd_tx_hold_write(dmu_tx_t *tx, uint64_t oid,
1011                                    dnode_t *dn, uint64_t off, int len)
1012 {
1013 #ifdef HAVE_DMU_TX_HOLD_ZAP_BY_DNODE
1014         if (dn) {
1015                 dmu_tx_hold_write_by_dnode(tx, dn, off, len);
1016                 return;
1017         }
1018 #endif
1019         dmu_tx_hold_write(tx, oid, off, len);
1020 }
1021
1022 static inline void osd_dmu_write(struct osd_device *osd, dnode_t *dn,
1023                                  uint64_t offset, uint64_t size,
1024                                  const char *buf, dmu_tx_t *tx)
1025 {
1026         LASSERT(dn);
1027 #ifdef HAVE_DMU_WRITE_BY_DNODE
1028         dmu_write_by_dnode(dn, offset, size, buf, tx);
1029 #else
1030         dmu_write(osd->od_os, dn->dn_object, offset, size, buf, tx);
1031 #endif
1032 }
1033
1034 static inline int osd_dmu_read(struct osd_device *osd, dnode_t *dn,
1035                                uint64_t offset, uint64_t size,
1036                                char *buf, int flags)
1037 {
1038         LASSERT(dn);
1039 #ifdef HAVE_DMU_READ_BY_DNODE
1040         return -dmu_read_by_dnode(dn, offset, size, buf, flags);
1041 #else
1042         return -dmu_read(osd->od_os, dn->dn_object, offset, size, buf, flags);
1043 #endif
1044 }
1045
1046 #ifdef HAVE_DMU_OBJSET_OWN_6ARG
1047 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1048         dmu_objset_own((name), (type), (ronly), (decrypt), (tag), (os))
1049 #else
1050 #define osd_dmu_objset_own(name, type, ronly, decrypt, tag, os) \
1051         dmu_objset_own((name), (type), (ronly), (tag), (os))
1052 #endif
1053
1054 #ifdef HAVE_DMU_OBJSET_DISOWN_3ARG
1055 #define osd_dmu_objset_disown(os, decrypt, tag) \
1056         dmu_objset_disown((os), (decrypt), (tag))
1057 #else
1058 #define osd_dmu_objset_disown(os, decrypt, tag) \
1059         dmu_objset_disown((os), (tag))
1060 #endif
1061
1062 static inline int
1063 osd_index_register(struct osd_device *osd, const struct lu_fid *fid,
1064                    __u32 keysize, __u32 recsize)
1065 {
1066         return lustre_index_register(&osd->od_dt_dev, osd_name(osd),
1067                                      &osd->od_index_backup_list, &osd->od_lock,
1068                                      &osd->od_index_backup_stop,
1069                                      fid, keysize, recsize);
1070 }
1071
1072 static inline void
1073 osd_index_backup(const struct lu_env *env, struct osd_device *osd, bool backup)
1074 {
1075         struct lu_fid *fid = &osd_oti_get(env)->oti_fid;
1076         int rc;
1077
1078         lu_local_obj_fid(fid, INDEX_BACKUP_OID);
1079         rc = osd_idc_find_and_init_with_oid(env, osd, fid,
1080                                             osd->od_index_backup_id);
1081         if (rc)
1082                 backup = false;
1083
1084         lustre_index_backup(env, &osd->od_dt_dev, osd_name(osd),
1085                             &osd->od_index_backup_list, &osd->od_lock,
1086                             &osd->od_index_backup_stop, backup);
1087 }
1088
1089 #endif /* _OSD_INTERNAL_H */