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