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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/osd-zfs/osd_internal.h
  37  * Shared definitions and declarations for zfs/dmu osd
  38  *
  39  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
  40  * Author: Mike Pershin <tappro@whamcloud.com>
  41  * Author: Johann Lombardi <johann@whamcloud.com>
  42  */
  43
  44 #ifndef _OSD_INTERNAL_H
  45 #define _OSD_INTERNAL_H
  46
  47 #include <dt_object.h>
  48 #include <md_object.h>
  49 #include <lustre_quota.h>
  50 #ifdef SHRINK_STOP
  51 #undef SHRINK_STOP
  52 #endif
  53 #include <sys/arc.h>
  54 #include <sys/nvpair.h>
  55 #include <sys/zfs_znode.h>
  56 #include <sys/zap.h>
  57
  58 /**
  59  * By design including kmem.h overrides the Linux slab interfaces to provide
  60  * the Illumos kmem cache interfaces.  To override this and gain access to
  61  * the Linux interfaces these preprocessor macros must be undefined.
  62  */
  63 #ifdef kmem_cache_destroy
  64 #undef kmem_cache_destroy
  65 #endif
  66
  67 #ifdef kmem_cache_create
  68 #undef kmem_cache_create
  69 #endif
  70
  71 #ifdef kmem_cache_alloc
  72 #undef kmem_cache_alloc
  73 #endif
  74
  75 #ifdef kmem_cache_free
  76 #undef kmem_cache_free
  77 #endif
  78
  79 #define LUSTRE_ROOT_FID_SEQ     0
  80 #define DMU_OSD_SVNAME          "svname"
  81 #define DMU_OSD_OI_NAME_BASE    "oi"
  82
  83 #define OSD_GFP_IO              (GFP_NOFS | __GFP_HIGHMEM)
  84
  85 /* Statfs space reservation for grant, fragmentation, and unlink space. */
  86 #define OSD_STATFS_RESERVED_SIZE        (16ULL << 20) /* reserve 16MB minimum */
  87 #define OSD_STATFS_RESERVED_SHIFT       (7)     /* reserve 0.78% of all space */
  88
  89 /* Statfs {minimum, safe estimate, and maximum} dnodes per block */
  90 #define OSD_DNODE_MIN_BLKSHIFT  (DNODES_PER_BLOCK_SHIFT)
  91 #define OSD_DNODE_EST_BLKSHIFT  (DNODES_PER_BLOCK_SHIFT >> 1)
  92 #define OSD_DNODE_EST_COUNT     1024
  93
  94 #define OSD_GRANT_FOR_LOCAL_OIDS (2ULL << 20) /* 2MB for last_rcvd, ... */
  95
  96 /**
  97  * Iterator's in-memory data structure for quota file.
  98  */
  99 struct osd_it_quota {
 100         struct osd_object       *oiq_obj;
 101         /* DMU accounting object id */
 102         uint64_t                 oiq_oid;
 103         /* ZAP cursor */
 104         zap_cursor_t            *oiq_zc;
 105         /** identifier for current quota record */
 106         __u64                    oiq_id;
 107         unsigned                 oiq_reset:1; /* 1 -- no need to advance */
 108 };
 109
 110 /**
 111  * Iterator's in-memory data structure for ZAPs
 112  *
 113  * ZFS does not store . and .. on a disk, instead they are
 114  * generated up on request
 115  * to follow this format we do the same
 116  */
 117 struct osd_zap_it {
 118         zap_cursor_t            *ozi_zc;
 119         struct osd_object       *ozi_obj;
 120         unsigned                 ozi_reset:1;   /* 1 -- no need to advance */
 121         /* ozi_pos - position of the cursor:
 122          * 0 - before any record
 123          * 1 - "."
 124          * 2 - ".."
 125          * 3 - real records */
 126         unsigned                 ozi_pos:3;
 127         union {
 128                 char             ozi_name[MAXNAMELEN]; /* file name for dir */
 129                 __u64            ozi_key; /* binary key for index files */
 130         };
 131 };
 132 #define DT_IT2DT(it) (&((struct osd_zap_it *)it)->ozi_obj->oo_dt)
 133
 134 /*
 135  * regular ZFS direntry
 136  */
 137 struct zpl_direntry {
 138         uint64_t        zde_dnode:48,
 139                         zde_pad:12,
 140                         zde_type:4;
 141 } __attribute__((packed));
 142
 143 /*
 144  * lustre direntry adds a fid to regular ZFS direntry
 145  */
 146 struct luz_direntry {
 147         struct zpl_direntry     lzd_reg;
 148         struct lu_fid           lzd_fid;
 149 } __attribute__((packed));
 150
 151
 152 /* cached SA attributes */
 153 struct osa_attr {
 154         uint64_t        mode;
 155         uint64_t        gid;
 156         uint64_t        uid;
 157         uint64_t        nlink;
 158         uint64_t        rdev;
 159         uint64_t        flags;
 160         uint64_t        size;
 161         uint64_t        atime[2];
 162         uint64_t        mtime[2];
 163         uint64_t        ctime[2];
 164 };
 165
 166 struct osd_thread_info {
 167         const struct lu_env     *oti_env;
 168
 169         struct lu_fid            oti_fid;
 170         /*
 171          * XXX temporary: for ->i_op calls.
 172          */
 173         struct timespec          oti_time;
 174
 175         struct ost_id            oti_ostid;
 176
 177         char                     oti_buf[64];
 178
 179         char                     oti_str[64];
 180         union {
 181                 char             oti_key[MAXNAMELEN + 1];
 182                 __u64            oti_key64[(MAXNAMELEN + 1)/sizeof(__u64)];
 183         };
 184         struct lustre_mdt_attrs oti_mdt_attrs;
 185
 186         struct lu_attr           oti_la;
 187         struct osa_attr          oti_osa;
 188         zap_attribute_t          oti_za;
 189         dmu_object_info_t        oti_doi;
 190         struct luz_direntry      oti_zde;
 191
 192         struct lquota_id_info    oti_qi;
 193         struct lu_seq_range      oti_seq_range;
 194 };
 195
 196 extern struct lu_context_key osd_key;
 197
 198 static inline struct osd_thread_info *osd_oti_get(const struct lu_env *env)
 199 {
 200         return lu_context_key_get(&env->le_ctx, &osd_key);
 201 }
 202
 203 struct osd_thandle {
 204         struct thandle           ot_super;
 205         struct list_head         ot_dcb_list;
 206         struct list_head         ot_stop_dcb_list;
 207         struct list_head         ot_unlinked_list;
 208         struct list_head         ot_sa_list;
 209         struct semaphore         ot_sa_lock;
 210         dmu_tx_t                *ot_tx;
 211         struct lquota_trans      ot_quota_trans;
 212         __u32                    ot_write_commit:1,
 213                                  ot_assigned:1;
 214 };
 215
 216 #define OSD_OI_NAME_SIZE        16
 217
 218 /*
 219  * Object Index (OI) instance.
 220  */
 221 struct osd_oi {
 222         char                    oi_name[OSD_OI_NAME_SIZE]; /* unused */
 223         uint64_t                oi_zapid;
 224 };
 225
 226 struct osd_seq {
 227         uint64_t         *os_compat_dirs;
 228         int              os_subdir_count; /* subdir count for each seq */
 229         u64              os_seq;          /* seq number */
 230         struct list_head os_seq_list;     /* list to seq_list */
 231 };
 232
 233 struct osd_seq_list {
 234         rwlock_t         osl_seq_list_lock;     /* lock for seq_list */
 235         struct list_head osl_seq_list;          /* list head for seq */
 236         struct semaphore osl_seq_init_sem;
 237 };
 238
 239 #define OSD_OST_MAP_SIZE        32
 240
 241 /*
 242  * osd device.
 243  */
 244 struct osd_device {
 245         /* super-class */
 246         struct dt_device         od_dt_dev;
 247         /* information about underlying file system */
 248         struct objset           *od_os;
 249         uint64_t                 od_rootid;  /* id of root znode */
 250         uint64_t                 od_unlinkedid; /* id of unlinked zapobj */
 251         /* SA attr mapping->id,
 252          * name is the same as in ZFS to use defines SA_ZPL_...*/
 253         sa_attr_type_t           *z_attr_table;
 254
 255         struct proc_dir_entry   *od_proc_entry;
 256         struct lprocfs_stats    *od_stats;
 257
 258         uint64_t                 od_max_blksz;
 259         uint64_t                 od_root;
 260         uint64_t                 od_O_id;
 261         struct osd_oi           **od_oi_table;
 262         unsigned int             od_oi_count;
 263         struct osd_seq_list     od_seq_list;
 264
 265         unsigned int             od_rdonly:1,
 266                                  od_xattr_in_sa:1,
 267                                  od_quota_iused_est:1,
 268                                  od_is_ost:1,
 269                                  od_posix_acl:1;
 270
 271         char                     od_mntdev[128];
 272         char                     od_svname[128];
 273
 274         int                      od_connects;
 275         struct lu_site           od_site;
 276
 277         /* object IDs of the inode accounting indexes */
 278         uint64_t                 od_iusr_oid;
 279         uint64_t                 od_igrp_oid;
 280
 281         /* quota slave instance */
 282         struct qsd_instance     *od_quota_slave;
 283
 284         struct brw_stats        od_brw_stats;
 285         atomic_t                od_r_in_flight;
 286         atomic_t                od_w_in_flight;
 287
 288         /* used to debug zerocopy logic: the fields track all
 289          * allocated, loaned and referenced buffers in use.
 290          * to be removed once the change is tested well. */
 291         atomic_t                 od_zerocopy_alloc;
 292         atomic_t                 od_zerocopy_loan;
 293         atomic_t                 od_zerocopy_pin;
 294
 295         arc_prune_t             *arc_prune_cb;
 296
 297         /* osd seq instance */
 298         struct lu_client_seq    *od_cl_seq;
 299 };
 300
 301 enum osd_destroy_type {
 302         OSD_DESTROY_NONE = 0,
 303         OSD_DESTROY_SYNC = 1,
 304         OSD_DESTROY_ASYNC = 2,
 305 };
 306
 307 struct osd_object {
 308         struct dt_object         oo_dt;
 309         /*
 310          * Inode for file system object represented by this osd_object. This
 311          * inode is pinned for the whole duration of lu_object life.
 312          *
 313          * Not modified concurrently (either setup early during object
 314          * creation, or assigned by osd_object_create() under write lock).
 315          */
 316         dmu_buf_t               *oo_db;
 317         sa_handle_t             *oo_sa_hdl;
 318         nvlist_t                *oo_sa_xattr;
 319         struct list_head         oo_sa_linkage;
 320         struct list_head         oo_unlinked_linkage;
 321
 322         struct rw_semaphore      oo_sem;
 323
 324         /* cached attributes */
 325         rwlock_t                 oo_attr_lock;
 326         struct lu_attr           oo_attr;
 327
 328         /* protects extended attributes and oo_unlinked_linkage */
 329         struct semaphore         oo_guard;
 330         uint64_t                 oo_xattr;
 331         enum osd_destroy_type    oo_destroy;
 332
 333         __u32                    oo_destroyed:1;
 334         /* record size for index file */
 335         unsigned char            oo_keysize;
 336         unsigned char            oo_recsize;
 337         unsigned char            oo_recusize;   /* unit size */
 338 };
 339
 340 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
 341 extern const struct dt_index_operations osd_acct_index_ops;
 342 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
 343 extern struct lu_device_operations  osd_lu_ops;
 344 extern struct dt_index_operations osd_dir_ops;
 345 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
 346                       qid_t uid, qid_t gid, long long space,
 347                       struct osd_thandle *oh, bool is_blk, int *flags,
 348                       bool force);
 349 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
 350                                  uint64_t nrblocks, uint64_t est_maxblockshift);
 351
 352 /*
 353  * Helpers.
 354  */
 355 static inline int lu_device_is_osd(const struct lu_device *d)
 356 {
 357         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 358 }
 359
 360 static inline struct osd_object *osd_obj(const struct lu_object *o)
 361 {
 362         LASSERT(lu_device_is_osd(o->lo_dev));
 363         return container_of0(o, struct osd_object, oo_dt.do_lu);
 364 }
 365
 366 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 367 {
 368         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 369         return container_of0(d, struct osd_device, od_dt_dev);
 370 }
 371
 372 static inline struct osd_device *osd_dev(const struct lu_device *d)
 373 {
 374         LASSERT(lu_device_is_osd(d));
 375         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 376 }
 377
 378 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 379 {
 380         return osd_obj(&d->do_lu);
 381 }
 382
 383 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 384 {
 385         return osd_dev(o->oo_dt.do_lu.lo_dev);
 386 }
 387
 388 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 389 {
 390         return &osd->od_dt_dev.dd_lu_dev;
 391 }
 392
 393 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
 394 {
 395         return osd_dev(o->do_lu.lo_dev)->od_os;
 396 }
 397
 398 static inline int osd_invariant(const struct osd_object *obj)
 399 {
 400         return 1;
 401 }
 402
 403 static inline int osd_object_invariant(const struct lu_object *l)
 404 {
 405         return osd_invariant(osd_obj(l));
 406 }
 407
 408 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
 409 {
 410         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 411 }
 412
 413 static inline char *osd_name(struct osd_device *osd)
 414 {
 415         return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
 416 }
 417
 418 #ifdef CONFIG_PROC_FS
 419 enum {
 420         LPROC_OSD_READ_BYTES = 0,
 421         LPROC_OSD_WRITE_BYTES = 1,
 422         LPROC_OSD_GET_PAGE = 2,
 423         LPROC_OSD_NO_PAGE = 3,
 424         LPROC_OSD_CACHE_ACCESS = 4,
 425         LPROC_OSD_CACHE_HIT = 5,
 426         LPROC_OSD_CACHE_MISS = 6,
 427         LPROC_OSD_COPY_IO = 7,
 428         LPROC_OSD_ZEROCOPY_IO = 8,
 429         LPROC_OSD_TAIL_IO = 9,
 430         LPROC_OSD_LAST,
 431 };
 432
 433 extern struct kmem_cache *osd_zapit_cachep;
 434 /* osd_lproc.c */
 435 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
 436
 437 int osd_procfs_init(struct osd_device *osd, const char *name);
 438 int osd_procfs_fini(struct osd_device *osd);
 439
 440 /* osd_object.c */
 441 extern char *osd_obj_tag;
 442 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
 443 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
 444                    uint64_t oid, dmu_buf_t **dbp);
 445 struct lu_object *osd_object_alloc(const struct lu_env *env,
 446                                    const struct lu_object_header *hdr,
 447                                    struct lu_device *d);
 448 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
 449                          void *buf, uint32_t buflen, struct osd_thandle *oh);
 450 int __osd_zap_create(const struct lu_env *env, struct osd_device *osd,
 451                      dmu_buf_t **zap_dbp, dmu_tx_t *tx, struct lu_attr *la,
 452                      uint64_t parent, zap_flags_t flags);
 453 int __osd_object_create(const struct lu_env *env, struct osd_object *obj,
 454                         dmu_buf_t **dbp, dmu_tx_t *tx, struct lu_attr *la,
 455                         uint64_t parent);
 456
 457 /* osd_oi.c */
 458 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
 459 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
 460 int osd_fid_lookup(const struct lu_env *env,
 461                    struct osd_device *, const struct lu_fid *, uint64_t *);
 462 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
 463                             const struct lu_fid *fid, char *buf);
 464 int osd_options_init(void);
 465 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
 466                        __u64 seq);
 467 /* osd_index.c */
 468 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
 469                   const struct dt_index_features *feat);
 470 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
 471                    u64 seq, struct lu_seq_range *range);
 472 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
 473                                     uint64_t id, uint64_t dirhash);
 474 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
 475                         uint64_t id, uint64_t dirhash);
 476 void osd_zap_cursor_fini(zap_cursor_t *zc);
 477 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc);
 478
 479 /* osd_xattr.c */
 480 int __osd_xattr_load(struct osd_device *osd, uint64_t dnode,
 481                      nvlist_t **sa_xattr);
 482 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
 483                           uint64_t xattr, struct lu_buf *buf,
 484                           const char *name, int *sizep);
 485 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
 486                   struct lu_buf *buf, const char *name);
 487 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
 488                           const struct lu_buf *buf, const char *name,
 489                           int fl, struct thandle *handle);
 490 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
 491                   const struct lu_buf *buf, const char *name, int fl,
 492                   struct thandle *handle);
 493 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
 494                           const char *name, struct thandle *handle);
 495 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
 496                   const char *name, struct thandle *handle);
 497 void osd_declare_xattrs_destroy(const struct lu_env *env,
 498                                 struct osd_object *obj,
 499                                 struct osd_thandle *oh);
 500 int osd_xattrs_destroy(const struct lu_env *env,
 501                        struct osd_object *obj, struct osd_thandle *oh);
 502 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
 503                    const struct lu_buf *lb);
 504 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
 505                         int vallen, const char *name, struct osd_thandle *oh);
 506 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
 507                        const struct lu_buf *buf, const char *name, int fl,
 508                        struct osd_thandle *oh);;
 509 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
 510                     const struct lu_buf *buf, const char *name, int fl,
 511                     struct osd_thandle *oh);
 512 static inline int
 513 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
 514                        const struct lu_buf *buf, const char *name, int fl,
 515                        struct osd_thandle *oh)
 516 {
 517         int rc;
 518
 519         if (osd_obj2dev(obj)->od_xattr_in_sa) {
 520                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
 521                 if (rc == -EFBIG)
 522                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
 523         } else {
 524                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
 525         }
 526
 527         return rc;
 528 }
 529
 530 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
 531 {
 532         return (((flags & FS_APPEND_FL)         ? ZFS_APPENDONLY        : 0) |
 533                 ((flags & FS_NODUMP_FL)         ? ZFS_NODUMP            : 0) |
 534                 ((flags & FS_IMMUTABLE_FL)      ? ZFS_IMMUTABLE         : 0));
 535 }
 536
 537 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
 538 {
 539         return (((flags & ZFS_APPENDONLY)       ? FS_APPEND_FL          : 0) |
 540                 ((flags & ZFS_NODUMP)           ? FS_NODUMP_FL          : 0) |
 541                 ((flags & ZFS_IMMUTABLE)        ? FS_IMMUTABLE_FL       : 0));
 542 }
 543
 544 #endif
 545
 546 #ifndef HAVE_DSL_POOL_CONFIG
 547 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
 548 {
 549 }
 550
 551 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
 552 {
 553 }
 554 #endif
 555
 556 #ifdef HAVE_SPA_MAXBLOCKSIZE
 557 #define osd_spa_maxblocksize(spa)       spa_maxblocksize(spa)
 558 #define osd_spa_maxblockshift(spa)      fls64(spa_maxblocksize(spa) - 1)
 559 #else
 560 #define osd_spa_maxblocksize(spa)       SPA_MAXBLOCKSIZE
 561 #define osd_spa_maxblockshift(spa)      SPA_MAXBLOCKSHIFT
 562 #define SPA_OLD_MAXBLOCKSIZE            SPA_MAXBLOCKSIZE
 563 #endif
 564
 565 #ifdef HAVE_SA_SPILL_ALLOC
 566 static inline void *
 567 osd_zio_buf_alloc(size_t size)
 568 {
 569         return sa_spill_alloc(KM_SLEEP);
 570 }
 571
 572 static inline void
 573 osd_zio_buf_free(void *buf, size_t size)
 574 {
 575         sa_spill_free(buf);
 576 }
 577 #else
 578 #define osd_zio_buf_alloc(size)         zio_buf_alloc(size)
 579 #define osd_zio_buf_free(buf, size)     zio_buf_free(buf, size)
 580 #endif
 581
 582 #endif /* _OSD_INTERNAL_H */