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