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