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