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