lustre/osd/osd_internal.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/osd/osd_internal.h
  37  *
  38  * Shared definitions and declarations for osd module
  39  *
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  */
  42
  43 #ifndef _OSD_INTERNAL_H
  44 #define _OSD_INTERNAL_H
  45
  46 #if defined(__KERNEL__)
  47
  48 /* struct rw_semaphore */
  49 #include <linux/rwsem.h>
  50 /* handle_t, journal_start(), journal_stop() */
  51 #include <linux/jbd.h>
  52 /* struct dx_hash_info */
  53 #include <linux/ldiskfs_fs.h>
  54 /* struct dentry */
  55 #include <linux/dcache.h>
  56 #include <linux/lustre_iam.h>
  57 /* struct dirent64 */
  58 #include <linux/dirent.h>
  59
  60 /* LUSTRE_OSD_NAME */
  61 #include <obd.h>
  62 /* class_register_type(), class_unregister_type(), class_get_type() */
  63 #include <obd_class.h>
  64 #include <lustre_disk.h>
  65
  66 #include <dt_object.h>
  67 #include "osd_oi.h"
  68
  69 struct inode;
  70
  71 #define OSD_OII_NOGEN (0)
  72 #define OSD_COUNTERS (0)
  73
  74 #ifdef HAVE_QUOTA_SUPPORT
  75 struct osd_ctxt {
  76         __u32 oc_uid;
  77         __u32 oc_gid;
  78         __u32 oc_cap;
  79 };
  80 #endif
  81
  82 /*
  83  * osd device.
  84  */
  85 struct osd_device {
  86         /* super-class */
  87         struct dt_device          od_dt_dev;
  88         /* information about underlying file system */
  89         struct lustre_mount_info *od_mount;
  90         /* object index */
  91         struct osd_oi             od_oi;
  92         /*
  93          * XXX temporary stuff for object index: directory where every object
  94          * is named by its fid.
  95          */
  96         struct dt_object         *od_obj_area;
  97
  98         /* Environment for transaction commit callback.
  99          * Currently, OSD is based on ext3/JBD. Transaction commit in ext3/JBD
 100          * is serialized, that is there is no more than one transaction commit
 101          * at a time (JBD journal_commit_transaction() is serialized).
 102          * This means that it's enough to have _one_ lu_context.
 103          */
 104         struct lu_env             od_env_for_commit;
 105
 106         /*
 107          * Fid Capability
 108          */
 109         unsigned int              od_fl_capa:1;
 110         unsigned long             od_capa_timeout;
 111         __u32                     od_capa_alg;
 112         struct lustre_capa_key   *od_capa_keys;
 113         struct hlist_head        *od_capa_hash;
 114
 115         cfs_proc_dir_entry_t     *od_proc_entry;
 116         struct lprocfs_stats     *od_stats;
 117         /*
 118          * statfs optimization: we cache a bit.
 119          */
 120         cfs_time_t                od_osfs_age;
 121         struct kstatfs            od_kstatfs;
 122         spinlock_t                od_osfs_lock;
 123
 124         /**
 125          * The following flag indicates, if it is interop mode or not.
 126          * It will be initialized, using mount param.
 127          */
 128         __u32                     od_iop_mode;
 129 };
 130
 131 struct osd_it_ea_dirent {
 132         __u64           oied_ino;
 133         __u64           oied_off;
 134         unsigned short  oied_namelen;
 135         unsigned int    oied_type;
 136         char            oied_name[0];
 137 } __attribute__((packed));
 138
 139 #define OSD_IT_EA_BUFSIZE       CFS_PAGE_SIZE
 140
 141 /**
 142  * This is iterator's in-memory data structure in interoperability
 143  * mode (i.e. iterator over ldiskfs style directory)
 144  */
 145 struct osd_it_ea {
 146         struct osd_object   *oie_obj;
 147         /** used in ldiskfs iterator, to stored file pointer */
 148         struct file          oie_file;
 149         /** current file position */
 150         __u64                oie_curr_pos;
 151         /** next file position */
 152         __u64                oie_next_pos;
 153         /** how many entries have been read-cached from storage */
 154         int                  oie_rd_dirent;
 155         /** current entry is being iterated by caller */
 156         int                  oie_it_dirent;
 157         /** current processing entry */
 158         struct osd_it_ea_dirent *oie_dirent;
 159         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 160         void                *oie_buf;
 161 };
 162
 163 /**
 164  * Iterator's in-memory data structure for IAM mode.
 165  */
 166 struct osd_it_iam {
 167         struct osd_object     *oi_obj;
 168         struct iam_path_descr *oi_ipd;
 169         struct iam_iterator    oi_it;
 170 };
 171
 172 struct osd_thread_info {
 173         const struct lu_env   *oti_env;
 174         /**
 175          * used for index operations.
 176          */
 177         struct dentry          oti_obj_dentry;
 178         struct dentry          oti_child_dentry;
 179
 180         /** dentry for Iterator context. */
 181         struct dentry          oti_it_dentry;
 182
 183         struct lu_fid          oti_fid;
 184         struct osd_inode_id    oti_id;
 185         /*
 186          * XXX temporary: for ->i_op calls.
 187          */
 188         struct txn_param       oti_txn;
 189         struct timespec        oti_time;
 190         struct timespec        oti_time2;
 191         /*
 192          * XXX temporary: fake struct file for osd_object_sync
 193          */
 194         struct file            oti_file;
 195         /*
 196          * XXX temporary: for capa operations.
 197          */
 198         struct lustre_capa_key oti_capa_key;
 199         struct lustre_capa     oti_capa;
 200
 201         struct lu_fid_pack     oti_pack;
 202
 203         /**
 204          * following ipd and it structures are used for osd_index_iam_lookup()
 205          * these are defined separately as we might do index operation
 206          * in open iterator session.
 207          */
 208
 209         /** osd iterator context used for iterator session */
 210
 211         union {
 212                 struct osd_it_iam      oti_it;
 213                 /** ldiskfs iterator data structure, see osd_it_ea_{init, fini} */
 214                 struct osd_it_ea       oti_it_ea;
 215         };
 216
 217         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 218         void                  *oti_it_ea_buf;
 219
 220         /** IAM iterator for index operation. */
 221         struct iam_iterator    oti_idx_it;
 222
 223         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 224         union {
 225                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 226                 long long      oti_alignment_lieutenant;
 227         };
 228
 229         union {
 230                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 231                 long long      oti_alignment_lieutenant_colonel;
 232         };
 233
 234
 235         int                    oti_r_locks;
 236         int                    oti_w_locks;
 237         int                    oti_txns;
 238         /** used in osd_fid_set() to put xattr */
 239         struct lu_buf          oti_buf;
 240         /** used in osd_ea_fid_set() to set fid into common ea */
 241         struct lustre_mdt_attrs oti_mdt_attrs;
 242 #ifdef HAVE_QUOTA_SUPPORT
 243         struct osd_ctxt        oti_ctxt;
 244 #endif
 245         struct lu_env          oti_obj_delete_tx_env;
 246 };
 247
 248 #ifdef LPROCFS
 249 /* osd_lproc.c */
 250 void lprocfs_osd_init_vars(struct lprocfs_static_vars *lvars);
 251 int osd_procfs_init(struct osd_device *osd, const char *name);
 252 int osd_procfs_fini(struct osd_device *osd);
 253 void osd_lprocfs_time_start(const struct lu_env *env);
 254 void osd_lprocfs_time_end(const struct lu_env *env,
 255                           struct osd_device *osd, int op);
 256 #endif
 257 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 258                struct kstatfs *sfs);
 259
 260 #endif /* __KERNEL__ */
 261 #endif /* _OSD_INTERNAL_H */