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