lustre/osd-ldiskfs/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 (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * Copyright (c) 2011 Whamcloud, Inc.
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  *
  39  * lustre/osd/osd_internal.h
  40  *
  41  * Shared definitions and declarations for osd module
  42  *
  43  * Author: Nikita Danilov <nikita@clusterfs.com>
  44  */
  45
  46 #ifndef _OSD_INTERNAL_H
  47 #define _OSD_INTERNAL_H
  48
  49 #if defined(__KERNEL__)
  50
  51 /* struct rw_semaphore */
  52 #include <linux/rwsem.h>
  53 /* struct dentry */
  54 #include <linux/dcache.h>
  55 /* struct dirent64 */
  56 #include <linux/dirent.h>
  57
  58 #ifdef HAVE_EXT4_LDISKFS
  59 #include <ldiskfs/ldiskfs.h>
  60 #include <ldiskfs/ldiskfs_jbd2.h>
  61 # ifdef HAVE_LDISKFS_JOURNAL_CALLBACK_ADD
  62 #  define journal_callback ldiskfs_journal_cb_entry
  63 #  define osd_journal_callback_set(handle, func, jcb) ldiskfs_journal_callback_add(handle, func, jcb)
  64 # else
  65 #  define osd_journal_callback_set(handle, func, jcb) jbd2_journal_callback_set(handle, func, jcb)
  66 # endif
  67 #else
  68 #include <linux/jbd.h>
  69 #include <linux/ldiskfs_fs.h>
  70 #include <linux/ldiskfs_jbd.h>
  71 #define osd_journal_callback_set(handle, func, jcb) journal_callback_set(handle, func, jcb)
  72 #endif
  73
  74
  75 /* LUSTRE_OSD_NAME */
  76 #include <obd.h>
  77 /* class_register_type(), class_unregister_type(), class_get_type() */
  78 #include <obd_class.h>
  79 #include <lustre_disk.h>
  80
  81 #include <dt_object.h>
  82 #include "osd_oi.h"
  83 #include "osd_iam.h"
  84
  85 struct inode;
  86
  87 #define OSD_OII_NOGEN (0)
  88 #define OSD_COUNTERS (0)
  89
  90 /** Enable thandle usage statistics */
  91 #define OSD_THANDLE_STATS (0)
  92
  93 #ifdef HAVE_QUOTA_SUPPORT
  94 struct osd_ctxt {
  95         __u32 oc_uid;
  96         __u32 oc_gid;
  97         cfs_kernel_cap_t oc_cap;
  98 };
  99 #endif
 100
 101 #ifdef HAVE_LDISKFS_PDO
 102
 103 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
 104         ll_ldiskfs_find_entry(dir, dentry, de, lock)
 105 #define osd_ldiskfs_add_entry(handle, child, cinode, hlock) \
 106         ldiskfs_add_entry(handle, child, cinode, hlock)
 107
 108 #else /* HAVE_LDISKFS_PDO */
 109
 110 struct htree_lock {
 111         int     dummy;
 112 };
 113
 114 struct htree_lock_head {
 115         int     dummy;
 116 };
 117
 118 #define ldiskfs_htree_lock(lock, head, inode, op)  do { LBUG(); } while (0)
 119 #define ldiskfs_htree_unlock(lock)                 do { LBUG(); } while (0)
 120
 121 static inline struct htree_lock_head *ldiskfs_htree_lock_head_alloc(int dep)
 122 {
 123         LBUG();
 124         return NULL;
 125 }
 126
 127 #define ldiskfs_htree_lock_head_free(lh)           do { LBUG(); } while (0)
 128
 129 #define LDISKFS_DUMMY_HTREE_LOCK        0xbabecafe
 130
 131 static inline struct htree_lock *ldiskfs_htree_lock_alloc(void)
 132 {
 133         return (struct htree_lock *)LDISKFS_DUMMY_HTREE_LOCK;
 134 }
 135
 136 static inline void ldiskfs_htree_lock_free(struct htree_lock *lk)
 137 {
 138         LASSERT((unsigned long)lk == LDISKFS_DUMMY_HTREE_LOCK);
 139 }
 140
 141 #define HTREE_HBITS_DEF         0
 142
 143 #define osd_ldiskfs_find_entry(dir, dentry, de, lock)   \
 144         ll_ldiskfs_find_entry(dir, dentry, de)
 145 #define osd_ldiskfs_add_entry(handle, child, cinode, lock) \
 146         ldiskfs_add_entry(handle, child, cinode)
 147
 148 #endif /* HAVE_LDISKFS_PDO */
 149
 150 /*
 151  * osd device.
 152  */
 153 struct osd_device {
 154         /* super-class */
 155         struct dt_device          od_dt_dev;
 156         /* information about underlying file system */
 157         struct lustre_mount_info *od_mount;
 158         /* object index */
 159         struct osd_oi             od_oi;
 160         /*
 161          * XXX temporary stuff for object index: directory where every object
 162          * is named by its fid.
 163          */
 164         struct dt_object         *od_obj_area;
 165
 166         /*
 167          * Fid Capability
 168          */
 169         unsigned int              od_fl_capa:1;
 170         unsigned long             od_capa_timeout;
 171         __u32                     od_capa_alg;
 172         struct lustre_capa_key   *od_capa_keys;
 173         cfs_hlist_head_t         *od_capa_hash;
 174
 175         cfs_proc_dir_entry_t     *od_proc_entry;
 176         struct lprocfs_stats     *od_stats;
 177         /*
 178          * statfs optimization: we cache a bit.
 179          */
 180         cfs_time_t                od_osfs_age;
 181         cfs_kstatfs_t             od_kstatfs;
 182         cfs_spinlock_t            od_osfs_lock;
 183
 184         /**
 185          * The following flag indicates, if it is interop mode or not.
 186          * It will be initialized, using mount param.
 187          */
 188         __u32                     od_iop_mode;
 189 };
 190
 191 /*
 192  * osd dev stats
 193  */
 194
 195 #ifdef LPROCFS
 196 enum {
 197 #if OSD_THANDLE_STATS
 198         LPROC_OSD_THANDLE_STARTING,
 199         LPROC_OSD_THANDLE_OPEN,
 200         LPROC_OSD_THANDLE_CLOSING,
 201 #endif
 202         LPROC_OSD_NR
 203 };
 204 #endif
 205
 206 /**
 207  * Storage representation for fids.
 208  *
 209  * Variable size, first byte contains the length of the whole record.
 210  */
 211 struct osd_fid_pack {
 212         unsigned char fp_len;
 213         char fp_area[sizeof(struct lu_fid)];
 214 };
 215
 216 struct osd_it_ea_dirent {
 217         struct lu_fid   oied_fid;
 218         __u64           oied_ino;
 219         __u64           oied_off;
 220         unsigned short  oied_namelen;
 221         unsigned int    oied_type;
 222         char            oied_name[0];
 223 } __attribute__((packed));
 224
 225 /**
 226  * as osd_it_ea_dirent (in memory dirent struct for osd) is greater
 227  * than lu_dirent struct. osd readdir reads less number of dirent than
 228  * required for mdd dir page. so buffer size need to be increased so that
 229  * there  would be one ext3 readdir for every mdd readdir page.
 230  */
 231
 232 #define OSD_IT_EA_BUFSIZE       (CFS_PAGE_SIZE + CFS_PAGE_SIZE/4)
 233
 234 /**
 235  * This is iterator's in-memory data structure in interoperability
 236  * mode (i.e. iterator over ldiskfs style directory)
 237  */
 238 struct osd_it_ea {
 239         struct osd_object   *oie_obj;
 240         /** used in ldiskfs iterator, to stored file pointer */
 241         struct file          oie_file;
 242         /** how many entries have been read-cached from storage */
 243         int                  oie_rd_dirent;
 244         /** current entry is being iterated by caller */
 245         int                  oie_it_dirent;
 246         /** current processing entry */
 247         struct osd_it_ea_dirent *oie_dirent;
 248         /** buffer to hold entries, size == OSD_IT_EA_BUFSIZE */
 249         void                *oie_buf;
 250 };
 251
 252 /**
 253  * Iterator's in-memory data structure for IAM mode.
 254  */
 255 struct osd_it_iam {
 256         struct osd_object     *oi_obj;
 257         struct iam_path_descr *oi_ipd;
 258         struct iam_iterator    oi_it;
 259 };
 260
 261 struct osd_thread_info {
 262         const struct lu_env   *oti_env;
 263         /**
 264          * used for index operations.
 265          */
 266         struct dentry          oti_obj_dentry;
 267         struct dentry          oti_child_dentry;
 268
 269         /** dentry for Iterator context. */
 270         struct dentry          oti_it_dentry;
 271         struct htree_lock     *oti_hlock;
 272
 273         struct lu_fid          oti_fid;
 274         struct osd_inode_id    oti_id;
 275         /*
 276          * XXX temporary: for ->i_op calls.
 277          */
 278         struct timespec        oti_time;
 279         /*
 280          * XXX temporary: fake struct file for osd_object_sync
 281          */
 282         struct file            oti_file;
 283         /*
 284          * XXX temporary: for capa operations.
 285          */
 286         struct lustre_capa_key oti_capa_key;
 287         struct lustre_capa     oti_capa;
 288
 289         /** osd_device reference, initialized in osd_trans_start() and
 290             used in osd_trans_stop() */
 291         struct osd_device     *oti_dev;
 292
 293         /**
 294          * following ipd and it structures are used for osd_index_iam_lookup()
 295          * these are defined separately as we might do index operation
 296          * in open iterator session.
 297          */
 298
 299         /** osd iterator context used for iterator session */
 300
 301         union {
 302                 struct osd_it_iam      oti_it;
 303                 /** ldiskfs iterator data structure, see osd_it_ea_{init, fini} */
 304                 struct osd_it_ea       oti_it_ea;
 305         };
 306
 307         /** pre-allocated buffer used by oti_it_ea, size OSD_IT_EA_BUFSIZE */
 308         void                  *oti_it_ea_buf;
 309
 310         /** IAM iterator for index operation. */
 311         struct iam_iterator    oti_idx_it;
 312
 313         /** union to guarantee that ->oti_ipd[] has proper alignment. */
 314         union {
 315                 char           oti_it_ipd[DX_IPD_MAX_SIZE];
 316                 long long      oti_alignment_lieutenant;
 317         };
 318
 319         union {
 320                 char           oti_idx_ipd[DX_IPD_MAX_SIZE];
 321                 long long      oti_alignment_lieutenant_colonel;
 322         };
 323
 324
 325         int                    oti_r_locks;
 326         int                    oti_w_locks;
 327         int                    oti_txns;
 328         /** used in osd_fid_set() to put xattr */
 329         struct lu_buf          oti_buf;
 330         /** used in osd_ea_fid_set() to set fid into common ea */
 331         struct lustre_mdt_attrs oti_mdt_attrs;
 332 #ifdef HAVE_QUOTA_SUPPORT
 333         struct osd_ctxt        oti_ctxt;
 334 #endif
 335         struct lu_env          oti_obj_delete_tx_env;
 336 #define OSD_FID_REC_SZ 32
 337         char                   oti_ldp[OSD_FID_REC_SZ];
 338         char                   oti_ldp2[OSD_FID_REC_SZ];
 339 };
 340
 341 extern int ldiskfs_pdo;
 342
 343 #ifdef LPROCFS
 344 /* osd_lproc.c */
 345 void lprocfs_osd_init_vars(struct lprocfs_static_vars *lvars);
 346 int osd_procfs_init(struct osd_device *osd, const char *name);
 347 int osd_procfs_fini(struct osd_device *osd);
 348 void osd_lprocfs_time_start(const struct lu_env *env);
 349 void osd_lprocfs_time_end(const struct lu_env *env,
 350                           struct osd_device *osd, int op);
 351 #endif
 352 int osd_statfs(const struct lu_env *env, struct dt_device *dev,
 353                cfs_kstatfs_t *sfs);
 354
 355 /*
 356  * Invariants, assertions.
 357  */
 358
 359 /*
 360  * XXX: do not enable this, until invariant checking code is made thread safe
 361  * in the face of pdirops locking.
 362  */
 363 #define OSD_INVARIANT_CHECKS (0)
 364
 365 #if OSD_INVARIANT_CHECKS
 366 static inline int osd_invariant(const struct osd_object *obj)
 367 {
 368         return
 369                 obj != NULL &&
 370                 ergo(obj->oo_inode != NULL,
 371                      obj->oo_inode->i_sb == osd_sb(osd_obj2dev(obj)) &&
 372                      atomic_read(&obj->oo_inode->i_count) > 0) &&
 373                 ergo(obj->oo_dir != NULL &&
 374                      obj->oo_dir->od_conationer.ic_object != NULL,
 375                      obj->oo_dir->od_conationer.ic_object == obj->oo_inode);
 376 }
 377 #else
 378 #define osd_invariant(obj) (1)
 379 #endif
 380
 381 /* The on-disk extN format reserves inodes 0-11 for internal filesystem
 382  * use, and these inodes will be invisible on client side, so the valid
 383  * sequence for IGIF fid is 12-0xffffffff. But root inode (2#) will be seen
 384  * on server side (osd), and it should be valid too here.
 385  */
 386 #define OSD_ROOT_SEQ            2
 387 static inline int osd_fid_is_root(const struct lu_fid *fid)
 388 {
 389         return fid_seq(fid) == OSD_ROOT_SEQ;
 390 }
 391
 392 static inline int osd_fid_is_igif(const struct lu_fid *fid)
 393 {
 394         return fid_is_igif(fid) || osd_fid_is_root(fid);
 395 }
 396
 397 #endif /* __KERNEL__ */
 398 #endif /* _OSD_INTERNAL_H */