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