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