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_BLKS  (1ULL << (22 - SPA_MAXBLOCKSHIFT)) /* 4MB */
  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 (SPA_MAXBLOCKSHIFT - DNODE_SHIFT) /* 17-9 =8 */
  91 #define OSD_DNODE_EST_BLKSHIFT (SPA_MAXBLOCKSHIFT - 12)          /* 17-12=5 */
  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_sa_list;
 207         struct semaphore         ot_sa_lock;
 208         dmu_tx_t                *ot_tx;
 209         struct lquota_trans      ot_quota_trans;
 210         __u32                    ot_write_commit:1,
 211                                  ot_assigned:1;
 212 };
 213
 214 #define OSD_OI_NAME_SIZE        16
 215
 216 /*
 217  * Object Index (OI) instance.
 218  */
 219 struct osd_oi {
 220         char                    oi_name[OSD_OI_NAME_SIZE]; /* unused */
 221         uint64_t                oi_zapid;
 222 };
 223
 224 struct osd_seq {
 225         uint64_t         *os_compat_dirs;
 226         int              os_subdir_count; /* subdir count for each seq */
 227         u64              os_seq;          /* seq number */
 228         struct list_head os_seq_list;     /* list to seq_list */
 229 };
 230
 231 struct osd_seq_list {
 232         rwlock_t         osl_seq_list_lock;     /* lock for seq_list */
 233         struct list_head osl_seq_list;          /* list head for seq */
 234         struct semaphore osl_seq_init_sem;
 235 };
 236
 237 #define OSD_OST_MAP_SIZE        32
 238
 239 /*
 240  * osd device.
 241  */
 242 struct osd_device {
 243         /* super-class */
 244         struct dt_device         od_dt_dev;
 245         /* information about underlying file system */
 246         struct objset           *od_os;
 247         uint64_t                 od_rootid;  /* id of root znode */
 248         /* SA attr mapping->id,
 249          * name is the same as in ZFS to use defines SA_ZPL_...*/
 250         sa_attr_type_t           *z_attr_table;
 251
 252         struct proc_dir_entry   *od_proc_entry;
 253         struct lprocfs_stats    *od_stats;
 254
 255         uint64_t                 od_root;
 256         uint64_t                 od_O_id;
 257         struct osd_oi           **od_oi_table;
 258         unsigned int             od_oi_count;
 259         struct osd_seq_list     od_seq_list;
 260
 261         unsigned int             od_rdonly:1,
 262                                  od_xattr_in_sa:1,
 263                                  od_quota_iused_est:1,
 264                                  od_is_ost:1,
 265                                  od_posix_acl:1;
 266
 267         char                     od_mntdev[128];
 268         char                     od_svname[128];
 269
 270         int                      od_connects;
 271         struct lu_site           od_site;
 272
 273         /* object IDs of the inode accounting indexes */
 274         uint64_t                 od_iusr_oid;
 275         uint64_t                 od_igrp_oid;
 276
 277         /* quota slave instance */
 278         struct qsd_instance     *od_quota_slave;
 279
 280         struct brw_stats        od_brw_stats;
 281         atomic_t                od_r_in_flight;
 282         atomic_t                od_w_in_flight;
 283
 284         /* used to debug zerocopy logic: the fields track all
 285          * allocated, loaned and referenced buffers in use.
 286          * to be removed once the change is tested well. */
 287         atomic_t                 od_zerocopy_alloc;
 288         atomic_t                 od_zerocopy_loan;
 289         atomic_t                 od_zerocopy_pin;
 290
 291         arc_prune_t             *arc_prune_cb;
 292
 293         /* osd seq instance */
 294         struct lu_client_seq    *od_cl_seq;
 295 };
 296
 297 struct osd_object {
 298         struct dt_object         oo_dt;
 299         /*
 300          * Inode for file system object represented by this osd_object. This
 301          * inode is pinned for the whole duration of lu_object life.
 302          *
 303          * Not modified concurrently (either setup early during object
 304          * creation, or assigned by osd_object_create() under write lock).
 305          */
 306         dmu_buf_t               *oo_db;
 307         sa_handle_t             *oo_sa_hdl;
 308         nvlist_t                *oo_sa_xattr;
 309         struct list_head         oo_sa_linkage;
 310
 311         struct rw_semaphore      oo_sem;
 312
 313         /* cached attributes */
 314         rwlock_t                 oo_attr_lock;
 315         struct lu_attr           oo_attr;
 316
 317         /* protects extended attributes */
 318         struct semaphore         oo_guard;
 319         uint64_t                 oo_xattr;
 320
 321         /* record size for index file */
 322         unsigned char            oo_keysize;
 323         unsigned char            oo_recsize;
 324         unsigned char            oo_recusize;   /* unit size */
 325 };
 326
 327 int osd_statfs(const struct lu_env *, struct dt_device *, struct obd_statfs *);
 328 extern const struct dt_index_operations osd_acct_index_ops;
 329 uint64_t osd_quota_fid2dmu(const struct lu_fid *fid);
 330 extern struct lu_device_operations  osd_lu_ops;
 331 extern struct dt_index_operations osd_dir_ops;
 332 int osd_declare_quota(const struct lu_env *env, struct osd_device *osd,
 333                       qid_t uid, qid_t gid, long long space,
 334                       struct osd_thandle *oh, bool is_blk, int *flags,
 335                       bool force);
 336 uint64_t osd_objs_count_estimate(uint64_t refdbytes, uint64_t usedobjs,
 337                                  uint64_t nrblocks);
 338
 339 /*
 340  * Helpers.
 341  */
 342 static inline int lu_device_is_osd(const struct lu_device *d)
 343 {
 344         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osd_lu_ops);
 345 }
 346
 347 static inline struct osd_object *osd_obj(const struct lu_object *o)
 348 {
 349         LASSERT(lu_device_is_osd(o->lo_dev));
 350         return container_of0(o, struct osd_object, oo_dt.do_lu);
 351 }
 352
 353 static inline struct osd_device *osd_dt_dev(const struct dt_device *d)
 354 {
 355         LASSERT(lu_device_is_osd(&d->dd_lu_dev));
 356         return container_of0(d, struct osd_device, od_dt_dev);
 357 }
 358
 359 static inline struct osd_device *osd_dev(const struct lu_device *d)
 360 {
 361         LASSERT(lu_device_is_osd(d));
 362         return osd_dt_dev(container_of0(d, struct dt_device, dd_lu_dev));
 363 }
 364
 365 static inline struct osd_object *osd_dt_obj(const struct dt_object *d)
 366 {
 367         return osd_obj(&d->do_lu);
 368 }
 369
 370 static inline struct osd_device *osd_obj2dev(const struct osd_object *o)
 371 {
 372         return osd_dev(o->oo_dt.do_lu.lo_dev);
 373 }
 374
 375 static inline struct lu_device *osd2lu_dev(struct osd_device *osd)
 376 {
 377         return &osd->od_dt_dev.dd_lu_dev;
 378 }
 379
 380 static inline struct objset * osd_dtobj2objset(struct dt_object *o)
 381 {
 382         return osd_dev(o->do_lu.lo_dev)->od_os;
 383 }
 384
 385 static inline int osd_invariant(const struct osd_object *obj)
 386 {
 387         return 1;
 388 }
 389
 390 static inline int osd_object_invariant(const struct lu_object *l)
 391 {
 392         return osd_invariant(osd_obj(l));
 393 }
 394
 395 static inline struct seq_server_site *osd_seq_site(struct osd_device *osd)
 396 {
 397         return osd->od_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 398 }
 399
 400 static inline char *osd_name(struct osd_device *osd)
 401 {
 402         return osd->od_dt_dev.dd_lu_dev.ld_obd->obd_name;
 403 }
 404
 405 #ifdef CONFIG_PROC_FS
 406 enum {
 407         LPROC_OSD_READ_BYTES = 0,
 408         LPROC_OSD_WRITE_BYTES = 1,
 409         LPROC_OSD_GET_PAGE = 2,
 410         LPROC_OSD_NO_PAGE = 3,
 411         LPROC_OSD_CACHE_ACCESS = 4,
 412         LPROC_OSD_CACHE_HIT = 5,
 413         LPROC_OSD_CACHE_MISS = 6,
 414         LPROC_OSD_COPY_IO = 7,
 415         LPROC_OSD_ZEROCOPY_IO = 8,
 416         LPROC_OSD_TAIL_IO = 9,
 417         LPROC_OSD_LAST,
 418 };
 419
 420 extern struct kmem_cache *osd_zapit_cachep;
 421 /* osd_lproc.c */
 422 extern struct lprocfs_vars lprocfs_osd_obd_vars[];
 423
 424 int osd_procfs_init(struct osd_device *osd, const char *name);
 425 int osd_procfs_fini(struct osd_device *osd);
 426
 427 /* osd_object.c */
 428 extern char *osd_obj_tag;
 429 void osd_object_sa_dirty_rele(struct osd_thandle *oh);
 430 int __osd_obj2dbuf(const struct lu_env *env, objset_t *os,
 431                    uint64_t oid, dmu_buf_t **dbp);
 432 struct lu_object *osd_object_alloc(const struct lu_env *env,
 433                                    const struct lu_object_header *hdr,
 434                                    struct lu_device *d);
 435 int osd_object_sa_update(struct osd_object *obj, sa_attr_type_t type,
 436                          void *buf, uint32_t buflen, struct osd_thandle *oh);
 437 int __osd_zap_create(const struct lu_env *env, struct osd_device *osd,
 438                      dmu_buf_t **zap_dbp, dmu_tx_t *tx, struct lu_attr *la,
 439                      uint64_t parent, zap_flags_t flags);
 440 int __osd_object_create(const struct lu_env *env, struct osd_object *obj,
 441                         dmu_buf_t **dbp, dmu_tx_t *tx, struct lu_attr *la,
 442                         uint64_t parent);
 443
 444 /* osd_oi.c */
 445 int osd_oi_init(const struct lu_env *env, struct osd_device *o);
 446 void osd_oi_fini(const struct lu_env *env, struct osd_device *o);
 447 int osd_fid_lookup(const struct lu_env *env,
 448                    struct osd_device *, const struct lu_fid *, uint64_t *);
 449 uint64_t osd_get_name_n_idx(const struct lu_env *env, struct osd_device *osd,
 450                             const struct lu_fid *fid, char *buf);
 451 int osd_options_init(void);
 452 int osd_convert_root_to_new_seq(const struct lu_env *env,
 453                                 struct osd_device *o);
 454 int osd_ost_seq_exists(const struct lu_env *env, struct osd_device *osd,
 455                        __u64 seq);
 456 /* osd_index.c */
 457 int osd_index_try(const struct lu_env *env, struct dt_object *dt,
 458                   const struct dt_index_features *feat);
 459 int osd_fld_lookup(const struct lu_env *env, struct osd_device *osd,
 460                    u64 seq, struct lu_seq_range *range);
 461 void osd_zap_cursor_init_serialized(zap_cursor_t *zc, struct objset *os,
 462                                     uint64_t id, uint64_t dirhash);
 463 int osd_zap_cursor_init(zap_cursor_t **zc, struct objset *os,
 464                         uint64_t id, uint64_t dirhash);
 465 void osd_zap_cursor_fini(zap_cursor_t *zc);
 466 uint64_t osd_zap_cursor_serialize(zap_cursor_t *zc);
 467
 468 /* osd_xattr.c */
 469 int __osd_xattr_load(struct osd_device *osd, uint64_t dnode,
 470                      nvlist_t **sa_xattr);
 471 int __osd_xattr_get_large(const struct lu_env *env, struct osd_device *osd,
 472                           uint64_t xattr, struct lu_buf *buf,
 473                           const char *name, int *sizep);
 474 int osd_xattr_get(const struct lu_env *env, struct dt_object *dt,
 475                   struct lu_buf *buf, const char *name);
 476 int osd_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
 477                           const struct lu_buf *buf, const char *name,
 478                           int fl, struct thandle *handle);
 479 int osd_xattr_set(const struct lu_env *env, struct dt_object *dt,
 480                   const struct lu_buf *buf, const char *name, int fl,
 481                   struct thandle *handle);
 482 int osd_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
 483                           const char *name, struct thandle *handle);
 484 int osd_xattr_del(const struct lu_env *env, struct dt_object *dt,
 485                   const char *name, struct thandle *handle);
 486 int osd_xattr_list(const struct lu_env *env, struct dt_object *dt,
 487                    const struct lu_buf *lb);
 488 void __osd_xattr_declare_set(const struct lu_env *env, struct osd_object *obj,
 489                         int vallen, const char *name, struct osd_thandle *oh);
 490 int __osd_sa_xattr_set(const struct lu_env *env, struct osd_object *obj,
 491                        const struct lu_buf *buf, const char *name, int fl,
 492                        struct osd_thandle *oh);;
 493 int __osd_xattr_set(const struct lu_env *env, struct osd_object *obj,
 494                     const struct lu_buf *buf, const char *name, int fl,
 495                     struct osd_thandle *oh);
 496 static inline int
 497 osd_xattr_set_internal(const struct lu_env *env, struct osd_object *obj,
 498                        const struct lu_buf *buf, const char *name, int fl,
 499                        struct osd_thandle *oh)
 500 {
 501         int rc;
 502
 503         if (osd_obj2dev(obj)->od_xattr_in_sa) {
 504                 rc = __osd_sa_xattr_set(env, obj, buf, name, fl, oh);
 505                 if (rc == -EFBIG)
 506                         rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
 507         } else {
 508                 rc = __osd_xattr_set(env, obj, buf, name, fl, oh);
 509         }
 510
 511         return rc;
 512 }
 513
 514 static inline uint64_t attrs_fs2zfs(const uint32_t flags)
 515 {
 516         return (((flags & FS_APPEND_FL)         ? ZFS_APPENDONLY        : 0) |
 517                 ((flags & FS_NODUMP_FL)         ? ZFS_NODUMP            : 0) |
 518                 ((flags & FS_IMMUTABLE_FL)      ? ZFS_IMMUTABLE         : 0));
 519 }
 520
 521 static inline uint32_t attrs_zfs2fs(const uint64_t flags)
 522 {
 523         return (((flags & ZFS_APPENDONLY)       ? FS_APPEND_FL          : 0) |
 524                 ((flags & ZFS_NODUMP)           ? FS_NODUMP_FL          : 0) |
 525                 ((flags & ZFS_IMMUTABLE)        ? FS_IMMUTABLE_FL       : 0));
 526 }
 527
 528 #endif
 529
 530 #ifndef HAVE_DSL_POOL_CONFIG
 531 static inline void dsl_pool_config_enter(dsl_pool_t *dp, char *name)
 532 {
 533 }
 534
 535 static inline void dsl_pool_config_exit(dsl_pool_t *dp, char *name)
 536 {
 537 }
 538
 539 #endif
 540
 541 #ifdef HAVE_SA_SPILL_ALLOC
 542 static inline void *
 543 osd_zio_buf_alloc(size_t size)
 544 {
 545         return sa_spill_alloc(KM_SLEEP);
 546 }
 547
 548 static inline void
 549 osd_zio_buf_free(void *buf, size_t size)
 550 {
 551         sa_spill_free(buf);
 552 }
 553 #else
 554 #define osd_zio_buf_alloc(size)         zio_buf_alloc(size)
 555 #define osd_zio_buf_free(buf, size)     zio_buf_free(buf, size)
 556 #endif
 557
 558 #endif /* _OSD_INTERNAL_H */