fs/ocfs2/ocfs2.h

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