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