fs/ocfs2/ocfs2.h

   1 /* -*- mode: c; c-basic-offset: 8; -*-
   2  * vim: noexpandtab sw=8 ts=8 sts=0:
   3  *
   4  * ocfs2.h
   5  *
   6  * Defines macros and structures used in OCFS2
   7  *
   8  * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public
  21  * License along with this program; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 021110-1307, USA.
  24  */
  25
  26 #ifndef OCFS2_H
  27 #define OCFS2_H
  28
  29 #include <linux/spinlock.h>
  30 #include <linux/sched.h>
  31 #include <linux/wait.h>
  32 #include <linux/list.h>
  33 #include <linux/rbtree.h>
  34 #include <linux/workqueue.h>
  35 #include <linux/kref.h>
  36 #include <linux/mutex.h>
  37 #include <linux/lockdep.h>
  38 #include <linux/jbd2.h>
  39
  40 /* For union ocfs2_dlm_lksb */
  41 #include "stackglue.h"
  42
  43 #include "ocfs2_fs.h"
  44 #include "ocfs2_lockid.h"
  45
  46 /* For struct ocfs2_blockcheck_stats */
  47 #include "blockcheck.h"
  48
  49
  50 /* Caching of metadata buffers */
  51
  52 /* Most user visible OCFS2 inodes will have very few pieces of
  53  * metadata, but larger files (including bitmaps, etc) must be taken
  54  * into account when designing an access scheme. We allow a small
  55  * amount of inlined blocks to be stored on an array and grow the
  56  * structure into a rb tree when necessary. */
  57 #define OCFS2_CACHE_INFO_MAX_ARRAY 2
  58
  59 /* Flags for ocfs2_caching_info */
  60
  61 enum ocfs2_caching_info_flags {
  62         /* Indicates that the metadata cache is using the inline array */
  63         OCFS2_CACHE_FL_INLINE   = 1<<1,
  64 };
  65
  66 struct ocfs2_caching_operations;
  67 struct ocfs2_caching_info {
  68         /*
  69          * The parent structure provides the locks, but because the
  70          * parent structure can differ, it provides locking operations
  71          * to struct ocfs2_caching_info.
  72          */
  73         const struct ocfs2_caching_operations *ci_ops;
  74
  75         /* next two are protected by trans_inc_lock */
  76         /* which transaction were we created on? Zero if none. */
  77         unsigned long           ci_created_trans;
  78         /* last transaction we were a part of. */
  79         unsigned long           ci_last_trans;
  80
  81         /* Cache structures */
  82         unsigned int            ci_flags;
  83         unsigned int            ci_num_cached;
  84         union {
  85         sector_t        ci_array[OCFS2_CACHE_INFO_MAX_ARRAY];
  86                 struct rb_root  ci_tree;
  87         } ci_cache;
  88 };
  89 /*
  90  * Need this prototype here instead of in uptodate.h because journal.h
  91  * uses it.
  92  */
  93 struct super_block *ocfs2_metadata_cache_get_super(struct ocfs2_caching_info *ci);
  94
  95 /* this limits us to 256 nodes
  96  * if we need more, we can do a kmalloc for the map */
  97 #define OCFS2_NODE_MAP_MAX_NODES    256
  98 struct ocfs2_node_map {
  99         u16 num_nodes;
 100         unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
 101 };
 102
 103 enum ocfs2_ast_action {
 104         OCFS2_AST_INVALID = 0,
 105         OCFS2_AST_ATTACH,
 106         OCFS2_AST_CONVERT,
 107         OCFS2_AST_DOWNCONVERT,
 108 };
 109
 110 /* actions for an unlockast function to take. */
 111 enum ocfs2_unlock_action {
 112         OCFS2_UNLOCK_INVALID = 0,
 113         OCFS2_UNLOCK_CANCEL_CONVERT,
 114         OCFS2_UNLOCK_DROP_LOCK,
 115 };
 116
 117 /* ocfs2_lock_res->l_flags flags. */
 118 #define OCFS2_LOCK_ATTACHED      (0x00000001) /* we have initialized
 119                                                * the lvb */
 120 #define OCFS2_LOCK_BUSY          (0x00000002) /* we are currently in
 121                                                * dlm_lock */
 122 #define OCFS2_LOCK_BLOCKED       (0x00000004) /* blocked waiting to
 123                                                * downconvert*/
 124 #define OCFS2_LOCK_LOCAL         (0x00000008) /* newly created inode */
 125 #define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
 126 #define OCFS2_LOCK_REFRESHING    (0x00000020)
 127 #define OCFS2_LOCK_INITIALIZED   (0x00000040) /* track initialization
 128                                                * for shutdown paths */
 129 #define OCFS2_LOCK_FREEING       (0x00000080) /* help dlmglue track
 130                                                * when to skip queueing
 131                                                * a lock because it's
 132                                                * about to be
 133                                                * dropped. */
 134 #define OCFS2_LOCK_QUEUED        (0x00000100) /* queued for downconvert */
 135 #define OCFS2_LOCK_NOCACHE       (0x00000200) /* don't use a holder count */
 136 #define OCFS2_LOCK_PENDING       (0x00000400) /* This lockres is pending a
 137                                                  call to dlm_lock.  Only
 138                                                  exists with BUSY set. */
 139
 140 struct ocfs2_lock_res_ops;
 141
 142 typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
 143
 144 struct ocfs2_lock_res {
 145         void                    *l_priv;
 146         struct ocfs2_lock_res_ops *l_ops;
 147         spinlock_t               l_lock;
 148
 149         struct list_head         l_blocked_list;
 150         struct list_head         l_mask_waiters;
 151
 152         enum ocfs2_lock_type     l_type;
 153         unsigned long            l_flags;
 154         char                     l_name[OCFS2_LOCK_ID_MAX_LEN];
 155         int                      l_level;
 156         unsigned int             l_ro_holders;
 157         unsigned int             l_ex_holders;
 158         union ocfs2_dlm_lksb     l_lksb;
 159
 160         /* used from AST/BAST funcs. */
 161         enum ocfs2_ast_action    l_action;
 162         enum ocfs2_unlock_action l_unlock_action;
 163         int                      l_requested;
 164         int                      l_blocking;
 165         unsigned int             l_pending_gen;
 166
 167         wait_queue_head_t        l_event;
 168
 169         struct list_head         l_debug_list;
 170
 171 #ifdef CONFIG_OCFS2_FS_STATS
 172         unsigned long long       l_lock_num_prmode;        /* PR acquires */
 173         unsigned long long       l_lock_num_exmode;        /* EX acquires */
 174         unsigned int             l_lock_num_prmode_failed; /* Failed PR gets */
 175         unsigned int             l_lock_num_exmode_failed; /* Failed EX gets */
 176         unsigned long long       l_lock_total_prmode;      /* Tot wait for PR */
 177         unsigned long long       l_lock_total_exmode;      /* Tot wait for EX */
 178         unsigned int             l_lock_max_prmode;        /* Max wait for PR */
 179         unsigned int             l_lock_max_exmode;        /* Max wait for EX */
 180         unsigned int             l_lock_refresh;           /* Disk refreshes */
 181 #endif
 182 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 183         struct lockdep_map       l_lockdep_map;
 184 #endif
 185 };
 186
 187 enum ocfs2_orphan_scan_state {
 188         ORPHAN_SCAN_ACTIVE,
 189         ORPHAN_SCAN_INACTIVE
 190 };
 191
 192 struct ocfs2_orphan_scan {
 193         struct mutex            os_lock;
 194         struct ocfs2_super      *os_osb;
 195         struct ocfs2_lock_res   os_lockres;     /* lock to synchronize scans */
 196         struct delayed_work     os_orphan_scan_work;
 197         struct timespec         os_scantime;  /* time this node ran the scan */
 198         u32                     os_count;      /* tracks node specific scans */
 199         u32                     os_seqno;       /* tracks cluster wide scans */
 200         atomic_t                os_state;              /* ACTIVE or INACTIVE */
 201 };
 202
 203 struct ocfs2_dlm_debug {
 204         struct kref d_refcnt;
 205         struct dentry *d_locking_state;
 206         struct list_head d_lockres_tracking;
 207 };
 208
 209 enum ocfs2_vol_state
 210 {
 211         VOLUME_INIT = 0,
 212         VOLUME_MOUNTED,
 213         VOLUME_MOUNTED_QUOTAS,
 214         VOLUME_DISMOUNTED,
 215         VOLUME_DISABLED
 216 };
 217
 218 struct ocfs2_alloc_stats
 219 {
 220         atomic_t moves;
 221         atomic_t local_data;
 222         atomic_t bitmap_data;
 223         atomic_t bg_allocs;
 224         atomic_t bg_extends;
 225 };
 226
 227 enum ocfs2_local_alloc_state
 228 {
 229         OCFS2_LA_UNUSED = 0,    /* Local alloc will never be used for
 230                                  * this mountpoint. */
 231         OCFS2_LA_ENABLED,       /* Local alloc is in use. */
 232         OCFS2_LA_THROTTLED,     /* Local alloc is in use, but number
 233                                  * of bits has been reduced. */
 234         OCFS2_LA_DISABLED       /* Local alloc has temporarily been
 235                                  * disabled. */
 236 };
 237
 238 enum ocfs2_mount_options
 239 {
 240         OCFS2_MOUNT_HB_LOCAL   = 1 << 0, /* Heartbeat started in local mode */
 241         OCFS2_MOUNT_BARRIER = 1 << 1,   /* Use block barriers */
 242         OCFS2_MOUNT_NOINTR  = 1 << 2,   /* Don't catch signals */
 243         OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
 244         OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
 245         OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
 246         OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
 247         OCFS2_MOUNT_INODE64 = 1 << 7,   /* Allow inode numbers > 2^32 */
 248         OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* POSIX access control lists */
 249         OCFS2_MOUNT_USRQUOTA = 1 << 9, /* We support user quotas */
 250         OCFS2_MOUNT_GRPQUOTA = 1 << 10, /* We support group quotas */
 251 };
 252
 253 #define OCFS2_OSB_SOFT_RO                       0x0001
 254 #define OCFS2_OSB_HARD_RO                       0x0002
 255 #define OCFS2_OSB_ERROR_FS                      0x0004
 256 #define OCFS2_OSB_DROP_DENTRY_LOCK_IMMED        0x0008
 257
 258 #define OCFS2_DEFAULT_ATIME_QUANTUM             60
 259
 260 struct ocfs2_journal;
 261 struct ocfs2_slot_info;
 262 struct ocfs2_recovery_map;
 263 struct ocfs2_replay_map;
 264 struct ocfs2_quota_recovery;
 265 struct ocfs2_dentry_lock;
 266 struct ocfs2_super
 267 {
 268         struct task_struct *commit_task;
 269         struct super_block *sb;
 270         struct inode *root_inode;
 271         struct inode *sys_root_inode;
 272         struct inode *system_inodes[NUM_SYSTEM_INODES];
 273
 274         struct ocfs2_slot_info *slot_info;
 275
 276         u32 *slot_recovery_generations;
 277
 278         spinlock_t node_map_lock;
 279
 280         u64 root_blkno;
 281         u64 system_dir_blkno;
 282         u64 bitmap_blkno;
 283         u32 bitmap_cpg;
 284         u8 *uuid;
 285         char *uuid_str;
 286         u32 uuid_hash;
 287         u8 *vol_label;
 288         u64 first_cluster_group_blkno;
 289         u32 fs_generation;
 290
 291         u32 s_feature_compat;
 292         u32 s_feature_incompat;
 293         u32 s_feature_ro_compat;
 294
 295         /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
 296          * Could protect more on osb as it's very short lived.
 297          */
 298         spinlock_t osb_lock;
 299         u32 s_next_generation;
 300         unsigned long osb_flags;
 301         s16 s_inode_steal_slot;
 302         atomic_t s_num_inodes_stolen;
 303
 304         unsigned long s_mount_opt;
 305         unsigned int s_atime_quantum;
 306
 307         unsigned int max_slots;
 308         unsigned int node_num;
 309         int slot_num;
 310         int preferred_slot;
 311         int s_sectsize_bits;
 312         int s_clustersize;
 313         int s_clustersize_bits;
 314         unsigned int s_xattr_inline_size;
 315
 316         atomic_t vol_state;
 317         struct mutex recovery_lock;
 318         struct ocfs2_recovery_map *recovery_map;
 319         struct ocfs2_replay_map *replay_map;
 320         struct task_struct *recovery_thread_task;
 321         int disable_recovery;
 322         wait_queue_head_t checkpoint_event;
 323         atomic_t needs_checkpoint;
 324         struct ocfs2_journal *journal;
 325         unsigned long osb_commit_interval;
 326
 327         struct delayed_work             la_enable_wq;
 328
 329         /*
 330          * Must hold local alloc i_mutex and osb->osb_lock to change
 331          * local_alloc_bits. Reads can be done under either lock.
 332          */
 333         unsigned int local_alloc_bits;
 334         unsigned int local_alloc_default_bits;
 335
 336         enum ocfs2_local_alloc_state local_alloc_state; /* protected
 337                                                          * by osb_lock */
 338
 339         struct buffer_head *local_alloc_bh;
 340
 341         u64 la_last_gd;
 342
 343         /* Next three fields are for local node slot recovery during
 344          * mount. */
 345         int dirty;
 346         struct ocfs2_dinode *local_alloc_copy;
 347         struct ocfs2_quota_recovery *quota_rec;
 348
 349         struct ocfs2_blockcheck_stats osb_ecc_stats;
 350         struct ocfs2_alloc_stats alloc_stats;
 351         char dev_str[20];               /* "major,minor" of the device */
 352
 353         char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
 354         struct ocfs2_cluster_connection *cconn;
 355         struct ocfs2_lock_res osb_super_lockres;
 356         struct ocfs2_lock_res osb_rename_lockres;
 357         struct ocfs2_lock_res osb_nfs_sync_lockres;
 358         struct ocfs2_dlm_debug *osb_dlm_debug;
 359
 360         struct dentry *osb_debug_root;
 361         struct dentry *osb_ctxt;
 362
 363         wait_queue_head_t recovery_event;
 364
 365         spinlock_t dc_task_lock;
 366         struct task_struct *dc_task;
 367         wait_queue_head_t dc_event;
 368         unsigned long dc_wake_sequence;
 369         unsigned long dc_work_sequence;
 370
 371         /*
 372          * Any thread can add locks to the list, but the downconvert
 373          * thread is the only one allowed to remove locks. Any change
 374          * to this rule requires updating
 375          * ocfs2_downconvert_thread_do_work().
 376          */
 377         struct list_head blocked_lock_list;
 378         unsigned long blocked_lock_count;
 379
 380         /* List of dentry locks to release. Anyone can add locks to
 381          * the list, ocfs2_wq processes the list  */
 382         struct ocfs2_dentry_lock *dentry_lock_list;
 383         struct work_struct dentry_lock_work;
 384
 385         wait_queue_head_t               osb_mount_event;
 386
 387         /* Truncate log info */
 388         struct inode                    *osb_tl_inode;
 389         struct buffer_head              *osb_tl_bh;
 390         struct delayed_work             osb_truncate_log_wq;
 391
 392         struct ocfs2_node_map           osb_recovering_orphan_dirs;
 393         unsigned int                    *osb_orphan_wipes;
 394         wait_queue_head_t               osb_wipe_event;
 395
 396         struct ocfs2_orphan_scan        osb_orphan_scan;
 397
 398         /* used to protect metaecc calculation check of xattr. */
 399         spinlock_t osb_xattr_lock;
 400
 401         unsigned int                    osb_dx_mask;
 402         u32                             osb_dx_seed[4];
 403
 404         /* the group we used to allocate inodes. */
 405         u64                             osb_inode_alloc_group;
 406
 407         /* rb tree root for refcount lock. */
 408         struct rb_root  osb_rf_lock_tree;
 409         struct ocfs2_refcount_tree *osb_ref_tree_lru;
 410 };
 411
 412 #define OCFS2_SB(sb)        ((struct ocfs2_super *)(sb)->s_fs_info)
 413
 414 /* Useful typedef for passing around journal access functions */
 415 typedef int (*ocfs2_journal_access_func)(handle_t *handle,
 416                                          struct ocfs2_caching_info *ci,
 417                                          struct buffer_head *bh, int type);
 418
 419 static inline int ocfs2_should_order_data(struct inode *inode)
 420 {
 421         if (!S_ISREG(inode->i_mode))
 422                 return 0;
 423         if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
 424                 return 0;
 425         return 1;
 426 }
 427
 428 static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
 429 {
 430         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
 431                 return 1;
 432         return 0;
 433 }
 434
 435 static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
 436 {
 437         /*
 438          * Support for sparse files is a pre-requisite
 439          */
 440         if (!ocfs2_sparse_alloc(osb))
 441                 return 0;
 442
 443         if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
 444                 return 1;
 445         return 0;
 446 }
 447
 448 static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
 449 {
 450         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
 451                 return 1;
 452         return 0;
 453 }
 454
 455 static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
 456 {
 457         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
 458                 return 1;
 459         return 0;
 460 }
 461
 462 static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
 463 {
 464         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
 465                 return 1;
 466         return 0;
 467 }
 468
 469 static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
 470 {
 471         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
 472                 return 1;
 473         return 0;
 474 }
 475
 476 static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
 477 {
 478         if (ocfs2_supports_indexed_dirs(osb))
 479                 return OCFS2_DX_LINK_MAX;
 480         return OCFS2_LINK_MAX;
 481 }
 482
 483 static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
 484 {
 485         u32 nlink = le16_to_cpu(di->i_links_count);
 486         u32 hi = le16_to_cpu(di->i_links_count_hi);
 487
 488         if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
 489                 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
 490
 491         return nlink;
 492 }
 493
 494 static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
 495 {
 496         u16 lo, hi;
 497
 498         lo = nlink;
 499         hi = nlink >> OCFS2_LINKS_HI_SHIFT;
 500
 501         di->i_links_count = cpu_to_le16(lo);
 502         di->i_links_count_hi = cpu_to_le16(hi);
 503 }
 504
 505 static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
 506 {
 507         u32 links = ocfs2_read_links_count(di);
 508
 509         links += n;
 510
 511         ocfs2_set_links_count(di, links);
 512 }
 513
 514 static inline int ocfs2_refcount_tree(struct ocfs2_super *osb)
 515 {
 516         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE)
 517                 return 1;
 518         return 0;
 519 }
 520
 521 /* set / clear functions because cluster events can make these happen
 522  * in parallel so we want the transitions to be atomic. this also
 523  * means that any future flags osb_flags must be protected by spinlock
 524  * too! */
 525 static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
 526                                       unsigned long flag)
 527 {
 528         spin_lock(&osb->osb_lock);
 529         osb->osb_flags |= flag;
 530         spin_unlock(&osb->osb_lock);
 531 }
 532
 533
 534 static inline unsigned long  ocfs2_test_osb_flag(struct ocfs2_super *osb,
 535                                                  unsigned long flag)
 536 {
 537         unsigned long ret;
 538
 539         spin_lock(&osb->osb_lock);
 540         ret = osb->osb_flags & flag;
 541         spin_unlock(&osb->osb_lock);
 542         return ret;
 543 }
 544
 545 static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
 546                                      int hard)
 547 {
 548         spin_lock(&osb->osb_lock);
 549         osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
 550         if (hard)
 551                 osb->osb_flags |= OCFS2_OSB_HARD_RO;
 552         else
 553                 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
 554         spin_unlock(&osb->osb_lock);
 555 }
 556
 557 static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
 558 {
 559         int ret;
 560
 561         spin_lock(&osb->osb_lock);
 562         ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
 563         spin_unlock(&osb->osb_lock);
 564
 565         return ret;
 566 }
 567
 568 static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
 569 {
 570         int ret;
 571
 572         spin_lock(&osb->osb_lock);
 573         ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
 574         spin_unlock(&osb->osb_lock);
 575
 576         return ret;
 577 }
 578
 579 static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
 580 {
 581         return (osb->s_feature_incompat &
 582                 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
 583 }
 584
 585 static inline int ocfs2_mount_local(struct ocfs2_super *osb)
 586 {
 587         return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
 588 }
 589
 590 static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
 591 {
 592         return (osb->s_feature_incompat &
 593                 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
 594 }
 595
 596
 597 #define OCFS2_IS_VALID_DINODE(ptr)                                      \
 598         (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
 599
 600 #define OCFS2_IS_VALID_EXTENT_BLOCK(ptr)                                \
 601         (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
 602
 603 #define OCFS2_IS_VALID_GROUP_DESC(ptr)                                  \
 604         (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
 605
 606
 607 #define OCFS2_IS_VALID_XATTR_BLOCK(ptr)                                 \
 608         (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
 609
 610 #define OCFS2_IS_VALID_DIR_TRAILER(ptr)                                 \
 611         (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
 612
 613 #define OCFS2_IS_VALID_DX_ROOT(ptr)                                     \
 614         (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
 615
 616 #define OCFS2_IS_VALID_DX_LEAF(ptr)                                     \
 617         (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
 618
 619 #define OCFS2_IS_VALID_REFCOUNT_BLOCK(ptr)                              \
 620         (!strcmp((ptr)->rf_signature, OCFS2_REFCOUNT_BLOCK_SIGNATURE))
 621
 622 static inline unsigned long ino_from_blkno(struct super_block *sb,
 623                                            u64 blkno)
 624 {
 625         return (unsigned long)(blkno & (u64)ULONG_MAX);
 626 }
 627
 628 static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
 629                                            u32 clusters)
 630 {
 631         int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
 632                 sb->s_blocksize_bits;
 633
 634         return (u64)clusters << c_to_b_bits;
 635 }
 636
 637 static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
 638                                            u64 blocks)
 639 {
 640         int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
 641                 sb->s_blocksize_bits;
 642
 643         return (u32)(blocks >> b_to_c_bits);
 644 }
 645
 646 static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
 647                                                     u64 bytes)
 648 {
 649         int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
 650         unsigned int clusters;
 651
 652         bytes += OCFS2_SB(sb)->s_clustersize - 1;
 653         /* OCFS2 just cannot have enough clusters to overflow this */
 654         clusters = (unsigned int)(bytes >> cl_bits);
 655
 656         return clusters;
 657 }
 658
 659 static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
 660                                          u64 bytes)
 661 {
 662         bytes += sb->s_blocksize - 1;
 663         return bytes >> sb->s_blocksize_bits;
 664 }
 665
 666 static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
 667                                           u32 clusters)
 668 {
 669         return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
 670 }
 671
 672 static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
 673                                                u64 blocks)
 674 {
 675         int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
 676         unsigned int clusters;
 677
 678         clusters = ocfs2_blocks_to_clusters(sb, blocks);
 679         return (u64)clusters << bits;
 680 }
 681
 682 static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
 683                                                 u64 bytes)
 684 {
 685         int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
 686         unsigned int clusters;
 687
 688         clusters = ocfs2_clusters_for_bytes(sb, bytes);
 689         return (u64)clusters << cl_bits;
 690 }
 691
 692 static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
 693                                               u64 bytes)
 694 {
 695         u64 blocks;
 696
 697         blocks = ocfs2_blocks_for_bytes(sb, bytes);
 698         return blocks << sb->s_blocksize_bits;
 699 }
 700
 701 static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
 702 {
 703         return (unsigned long)((bytes + 511) >> 9);
 704 }
 705
 706 static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
 707                                                         unsigned long pg_index)
 708 {
 709         u32 clusters = pg_index;
 710         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
 711
 712         if (unlikely(PAGE_CACHE_SHIFT > cbits))
 713                 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
 714         else if (PAGE_CACHE_SHIFT < cbits)
 715                 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
 716
 717         return clusters;
 718 }
 719
 720 /*
 721  * Find the 1st page index which covers the given clusters.
 722  */
 723 static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
 724                                                         u32 clusters)
 725 {
 726         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
 727         pgoff_t index = clusters;
 728
 729         if (PAGE_CACHE_SHIFT > cbits) {
 730                 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
 731         } else if (PAGE_CACHE_SHIFT < cbits) {
 732                 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
 733         }
 734
 735         return index;
 736 }
 737
 738 static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
 739 {
 740         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
 741         unsigned int pages_per_cluster = 1;
 742
 743         if (PAGE_CACHE_SHIFT < cbits)
 744                 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
 745
 746         return pages_per_cluster;
 747 }
 748
 749 static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
 750                                                        unsigned int megs)
 751 {
 752         BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
 753
 754         return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
 755 }
 756
 757 static inline void ocfs2_init_inode_steal_slot(struct ocfs2_super *osb)
 758 {
 759         spin_lock(&osb->osb_lock);
 760         osb->s_inode_steal_slot = OCFS2_INVALID_SLOT;
 761         spin_unlock(&osb->osb_lock);
 762         atomic_set(&osb->s_num_inodes_stolen, 0);
 763 }
 764
 765 static inline void ocfs2_set_inode_steal_slot(struct ocfs2_super *osb,
 766                                               s16 slot)
 767 {
 768         spin_lock(&osb->osb_lock);
 769         osb->s_inode_steal_slot = slot;
 770         spin_unlock(&osb->osb_lock);
 771 }
 772
 773 static inline s16 ocfs2_get_inode_steal_slot(struct ocfs2_super *osb)
 774 {
 775         s16 slot;
 776
 777         spin_lock(&osb->osb_lock);
 778         slot = osb->s_inode_steal_slot;
 779         spin_unlock(&osb->osb_lock);
 780
 781         return slot;
 782 }
 783
 784 #define ocfs2_set_bit ext2_set_bit
 785 #define ocfs2_clear_bit ext2_clear_bit
 786 #define ocfs2_test_bit ext2_test_bit
 787 #define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
 788 #define ocfs2_find_next_bit ext2_find_next_bit
 789 #endif  /* OCFS2_H */
 790