Reorganize data elements to reduce struct sizes
[firefly-linux-kernel-4.4.55.git] / 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 struct ocfs2_lock_res {
151         void                    *l_priv;
152         struct ocfs2_lock_res_ops *l_ops;
153
154
155         struct list_head         l_blocked_list;
156         struct list_head         l_mask_waiters;
157
158         unsigned long            l_flags;
159         char                     l_name[OCFS2_LOCK_ID_MAX_LEN];
160         unsigned int             l_ro_holders;
161         unsigned int             l_ex_holders;
162         unsigned char            l_level;
163
164         /* Data packed - type enum ocfs2_lock_type */
165         unsigned char            l_type;
166
167         /* used from AST/BAST funcs. */
168         /* Data packed - enum type ocfs2_ast_action */
169         unsigned char            l_action;
170         /* Data packed - enum type ocfs2_unlock_action */
171         unsigned char            l_unlock_action;
172         unsigned char            l_requested;
173         unsigned char            l_blocking;
174         unsigned int             l_pending_gen;
175
176         spinlock_t               l_lock;
177
178         struct ocfs2_dlm_lksb    l_lksb;
179
180         wait_queue_head_t        l_event;
181
182         struct list_head         l_debug_list;
183
184 #ifdef CONFIG_OCFS2_FS_STATS
185         unsigned long long       l_lock_num_prmode;        /* PR acquires */
186         unsigned long long       l_lock_num_exmode;        /* EX acquires */
187         unsigned int             l_lock_num_prmode_failed; /* Failed PR gets */
188         unsigned int             l_lock_num_exmode_failed; /* Failed EX gets */
189         unsigned long long       l_lock_total_prmode;      /* Tot wait for PR */
190         unsigned long long       l_lock_total_exmode;      /* Tot wait for EX */
191         unsigned int             l_lock_max_prmode;        /* Max wait for PR */
192         unsigned int             l_lock_max_exmode;        /* Max wait for EX */
193         unsigned int             l_lock_refresh;           /* Disk refreshes */
194 #endif
195 #ifdef CONFIG_DEBUG_LOCK_ALLOC
196         struct lockdep_map       l_lockdep_map;
197 #endif
198 };
199
200 enum ocfs2_orphan_scan_state {
201         ORPHAN_SCAN_ACTIVE,
202         ORPHAN_SCAN_INACTIVE
203 };
204
205 struct ocfs2_orphan_scan {
206         struct mutex            os_lock;
207         struct ocfs2_super      *os_osb;
208         struct ocfs2_lock_res   os_lockres;     /* lock to synchronize scans */
209         struct delayed_work     os_orphan_scan_work;
210         struct timespec         os_scantime;  /* time this node ran the scan */
211         u32                     os_count;      /* tracks node specific scans */
212         u32                     os_seqno;       /* tracks cluster wide scans */
213         atomic_t                os_state;              /* ACTIVE or INACTIVE */
214 };
215
216 struct ocfs2_dlm_debug {
217         struct kref d_refcnt;
218         struct dentry *d_locking_state;
219         struct list_head d_lockres_tracking;
220 };
221
222 enum ocfs2_vol_state
223 {
224         VOLUME_INIT = 0,
225         VOLUME_MOUNTED,
226         VOLUME_MOUNTED_QUOTAS,
227         VOLUME_DISMOUNTED,
228         VOLUME_DISABLED
229 };
230
231 struct ocfs2_alloc_stats
232 {
233         atomic_t moves;
234         atomic_t local_data;
235         atomic_t bitmap_data;
236         atomic_t bg_allocs;
237         atomic_t bg_extends;
238 };
239
240 enum ocfs2_local_alloc_state
241 {
242         OCFS2_LA_UNUSED = 0,    /* Local alloc will never be used for
243                                  * this mountpoint. */
244         OCFS2_LA_ENABLED,       /* Local alloc is in use. */
245         OCFS2_LA_THROTTLED,     /* Local alloc is in use, but number
246                                  * of bits has been reduced. */
247         OCFS2_LA_DISABLED       /* Local alloc has temporarily been
248                                  * disabled. */
249 };
250
251 enum ocfs2_mount_options
252 {
253         OCFS2_MOUNT_HB_LOCAL   = 1 << 0, /* Heartbeat started in local mode */
254         OCFS2_MOUNT_BARRIER = 1 << 1,   /* Use block barriers */
255         OCFS2_MOUNT_NOINTR  = 1 << 2,   /* Don't catch signals */
256         OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
257         OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
258         OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
259         OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
260         OCFS2_MOUNT_INODE64 = 1 << 7,   /* Allow inode numbers > 2^32 */
261         OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* Force POSIX access control lists */
262         OCFS2_MOUNT_NO_POSIX_ACL = 1 << 9,      /* Disable POSIX access
263                                                    control lists */
264         OCFS2_MOUNT_USRQUOTA = 1 << 10, /* We support user quotas */
265         OCFS2_MOUNT_GRPQUOTA = 1 << 11, /* We support group quotas */
266 };
267
268 #define OCFS2_OSB_SOFT_RO                       0x0001
269 #define OCFS2_OSB_HARD_RO                       0x0002
270 #define OCFS2_OSB_ERROR_FS                      0x0004
271 #define OCFS2_OSB_DROP_DENTRY_LOCK_IMMED        0x0008
272
273 #define OCFS2_DEFAULT_ATIME_QUANTUM             60
274
275 struct ocfs2_journal;
276 struct ocfs2_slot_info;
277 struct ocfs2_recovery_map;
278 struct ocfs2_replay_map;
279 struct ocfs2_quota_recovery;
280 struct ocfs2_dentry_lock;
281 struct ocfs2_super
282 {
283         struct task_struct *commit_task;
284         struct super_block *sb;
285         struct inode *root_inode;
286         struct inode *sys_root_inode;
287         struct inode *system_inodes[NUM_SYSTEM_INODES];
288
289         struct ocfs2_slot_info *slot_info;
290
291         u32 *slot_recovery_generations;
292
293         spinlock_t node_map_lock;
294
295         u64 root_blkno;
296         u64 system_dir_blkno;
297         u64 bitmap_blkno;
298         u32 bitmap_cpg;
299         u8 *uuid;
300         char *uuid_str;
301         u32 uuid_hash;
302         u8 *vol_label;
303         u64 first_cluster_group_blkno;
304         u32 fs_generation;
305
306         u32 s_feature_compat;
307         u32 s_feature_incompat;
308         u32 s_feature_ro_compat;
309
310         /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
311          * Could protect more on osb as it's very short lived.
312          */
313         spinlock_t osb_lock;
314         u32 s_next_generation;
315         unsigned long osb_flags;
316         s16 s_inode_steal_slot;
317         s16 s_meta_steal_slot;
318         atomic_t s_num_inodes_stolen;
319         atomic_t s_num_meta_stolen;
320
321         unsigned long s_mount_opt;
322         unsigned int s_atime_quantum;
323
324         unsigned int max_slots;
325         unsigned int node_num;
326         int slot_num;
327         int preferred_slot;
328         int s_sectsize_bits;
329         int s_clustersize;
330         int s_clustersize_bits;
331         unsigned int s_xattr_inline_size;
332
333         atomic_t vol_state;
334         struct mutex recovery_lock;
335         struct ocfs2_recovery_map *recovery_map;
336         struct ocfs2_replay_map *replay_map;
337         struct task_struct *recovery_thread_task;
338         int disable_recovery;
339         wait_queue_head_t checkpoint_event;
340         atomic_t needs_checkpoint;
341         struct ocfs2_journal *journal;
342         unsigned long osb_commit_interval;
343
344         struct delayed_work             la_enable_wq;
345
346         /*
347          * Must hold local alloc i_mutex and osb->osb_lock to change
348          * local_alloc_bits. Reads can be done under either lock.
349          */
350         unsigned int local_alloc_bits;
351         unsigned int local_alloc_default_bits;
352         /* osb_clusters_at_boot can become stale! Do not trust it to
353          * be up to date. */
354         unsigned int osb_clusters_at_boot;
355
356         enum ocfs2_local_alloc_state local_alloc_state; /* protected
357                                                          * by osb_lock */
358
359         struct buffer_head *local_alloc_bh;
360
361         u64 la_last_gd;
362
363         struct ocfs2_reservation_map    osb_la_resmap;
364
365         unsigned int    osb_resv_level;
366         unsigned int    osb_dir_resv_level;
367
368         /* Next three fields are for local node slot recovery during
369          * mount. */
370         int dirty;
371         struct ocfs2_dinode *local_alloc_copy;
372         struct ocfs2_quota_recovery *quota_rec;
373
374         struct ocfs2_blockcheck_stats osb_ecc_stats;
375         struct ocfs2_alloc_stats alloc_stats;
376         char dev_str[20];               /* "major,minor" of the device */
377
378         char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
379         struct ocfs2_cluster_connection *cconn;
380         struct ocfs2_lock_res osb_super_lockres;
381         struct ocfs2_lock_res osb_rename_lockres;
382         struct ocfs2_lock_res osb_nfs_sync_lockres;
383         struct ocfs2_dlm_debug *osb_dlm_debug;
384
385         struct dentry *osb_debug_root;
386         struct dentry *osb_ctxt;
387
388         wait_queue_head_t recovery_event;
389
390         spinlock_t dc_task_lock;
391         struct task_struct *dc_task;
392         wait_queue_head_t dc_event;
393         unsigned long dc_wake_sequence;
394         unsigned long dc_work_sequence;
395
396         /*
397          * Any thread can add locks to the list, but the downconvert
398          * thread is the only one allowed to remove locks. Any change
399          * to this rule requires updating
400          * ocfs2_downconvert_thread_do_work().
401          */
402         struct list_head blocked_lock_list;
403         unsigned long blocked_lock_count;
404
405         /* List of dentry locks to release. Anyone can add locks to
406          * the list, ocfs2_wq processes the list  */
407         struct ocfs2_dentry_lock *dentry_lock_list;
408         struct work_struct dentry_lock_work;
409
410         wait_queue_head_t               osb_mount_event;
411
412         /* Truncate log info */
413         struct inode                    *osb_tl_inode;
414         struct buffer_head              *osb_tl_bh;
415         struct delayed_work             osb_truncate_log_wq;
416
417         struct ocfs2_node_map           osb_recovering_orphan_dirs;
418         unsigned int                    *osb_orphan_wipes;
419         wait_queue_head_t               osb_wipe_event;
420
421         struct ocfs2_orphan_scan        osb_orphan_scan;
422
423         /* used to protect metaecc calculation check of xattr. */
424         spinlock_t osb_xattr_lock;
425
426         unsigned int                    osb_dx_mask;
427         u32                             osb_dx_seed[4];
428
429         /* the group we used to allocate inodes. */
430         u64                             osb_inode_alloc_group;
431
432         /* rb tree root for refcount lock. */
433         struct rb_root  osb_rf_lock_tree;
434         struct ocfs2_refcount_tree *osb_ref_tree_lru;
435 };
436
437 #define OCFS2_SB(sb)        ((struct ocfs2_super *)(sb)->s_fs_info)
438
439 /* Useful typedef for passing around journal access functions */
440 typedef int (*ocfs2_journal_access_func)(handle_t *handle,
441                                          struct ocfs2_caching_info *ci,
442                                          struct buffer_head *bh, int type);
443
444 static inline int ocfs2_should_order_data(struct inode *inode)
445 {
446         if (!S_ISREG(inode->i_mode))
447                 return 0;
448         if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
449                 return 0;
450         return 1;
451 }
452
453 static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
454 {
455         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
456                 return 1;
457         return 0;
458 }
459
460 static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
461 {
462         /*
463          * Support for sparse files is a pre-requisite
464          */
465         if (!ocfs2_sparse_alloc(osb))
466                 return 0;
467
468         if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
469                 return 1;
470         return 0;
471 }
472
473 static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
474 {
475         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
476                 return 1;
477         return 0;
478 }
479
480 static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
481 {
482         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
483                 return 1;
484         return 0;
485 }
486
487 static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
488 {
489         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
490                 return 1;
491         return 0;
492 }
493
494 static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
495 {
496         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
497                 return 1;
498         return 0;
499 }
500
501 static inline int ocfs2_supports_discontig_bg(struct ocfs2_super *osb)
502 {
503         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_DISCONTIG_BG)
504                 return 1;
505         return 0;
506 }
507
508 static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
509 {
510         if (ocfs2_supports_indexed_dirs(osb))
511                 return OCFS2_DX_LINK_MAX;
512         return OCFS2_LINK_MAX;
513 }
514
515 static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
516 {
517         u32 nlink = le16_to_cpu(di->i_links_count);
518         u32 hi = le16_to_cpu(di->i_links_count_hi);
519
520         if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
521                 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
522
523         return nlink;
524 }
525
526 static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
527 {
528         u16 lo, hi;
529
530         lo = nlink;
531         hi = nlink >> OCFS2_LINKS_HI_SHIFT;
532
533         di->i_links_count = cpu_to_le16(lo);
534         di->i_links_count_hi = cpu_to_le16(hi);
535 }
536
537 static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
538 {
539         u32 links = ocfs2_read_links_count(di);
540
541         links += n;
542
543         ocfs2_set_links_count(di, links);
544 }
545
546 static inline int ocfs2_refcount_tree(struct ocfs2_super *osb)
547 {
548         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE)
549                 return 1;
550         return 0;
551 }
552
553 /* set / clear functions because cluster events can make these happen
554  * in parallel so we want the transitions to be atomic. this also
555  * means that any future flags osb_flags must be protected by spinlock
556  * too! */
557 static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
558                                       unsigned long flag)
559 {
560         spin_lock(&osb->osb_lock);
561         osb->osb_flags |= flag;
562         spin_unlock(&osb->osb_lock);
563 }
564
565
566 static inline unsigned long  ocfs2_test_osb_flag(struct ocfs2_super *osb,
567                                                  unsigned long flag)
568 {
569         unsigned long ret;
570
571         spin_lock(&osb->osb_lock);
572         ret = osb->osb_flags & flag;
573         spin_unlock(&osb->osb_lock);
574         return ret;
575 }
576
577 static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
578                                      int hard)
579 {
580         spin_lock(&osb->osb_lock);
581         osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
582         if (hard)
583                 osb->osb_flags |= OCFS2_OSB_HARD_RO;
584         else
585                 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
586         spin_unlock(&osb->osb_lock);
587 }
588
589 static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
590 {
591         int ret;
592
593         spin_lock(&osb->osb_lock);
594         ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
595         spin_unlock(&osb->osb_lock);
596
597         return ret;
598 }
599
600 static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
601 {
602         int ret;
603
604         spin_lock(&osb->osb_lock);
605         ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
606         spin_unlock(&osb->osb_lock);
607
608         return ret;
609 }
610
611 static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
612 {
613         return (osb->s_feature_incompat &
614                 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
615 }
616
617 static inline int ocfs2_mount_local(struct ocfs2_super *osb)
618 {
619         return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
620 }
621
622 static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
623 {
624         return (osb->s_feature_incompat &
625                 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
626 }
627
628
629 #define OCFS2_IS_VALID_DINODE(ptr)                                      \
630         (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
631
632 #define OCFS2_IS_VALID_EXTENT_BLOCK(ptr)                                \
633         (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
634
635 #define OCFS2_IS_VALID_GROUP_DESC(ptr)                                  \
636         (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
637
638
639 #define OCFS2_IS_VALID_XATTR_BLOCK(ptr)                                 \
640         (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
641
642 #define OCFS2_IS_VALID_DIR_TRAILER(ptr)                                 \
643         (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
644
645 #define OCFS2_IS_VALID_DX_ROOT(ptr)                                     \
646         (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
647
648 #define OCFS2_IS_VALID_DX_LEAF(ptr)                                     \
649         (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
650
651 #define OCFS2_IS_VALID_REFCOUNT_BLOCK(ptr)                              \
652         (!strcmp((ptr)->rf_signature, OCFS2_REFCOUNT_BLOCK_SIGNATURE))
653
654 static inline unsigned long ino_from_blkno(struct super_block *sb,
655                                            u64 blkno)
656 {
657         return (unsigned long)(blkno & (u64)ULONG_MAX);
658 }
659
660 static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
661                                            u32 clusters)
662 {
663         int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
664                 sb->s_blocksize_bits;
665
666         return (u64)clusters << c_to_b_bits;
667 }
668
669 static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
670                                            u64 blocks)
671 {
672         int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
673                 sb->s_blocksize_bits;
674
675         return (u32)(blocks >> b_to_c_bits);
676 }
677
678 static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
679                                                     u64 bytes)
680 {
681         int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
682         unsigned int clusters;
683
684         bytes += OCFS2_SB(sb)->s_clustersize - 1;
685         /* OCFS2 just cannot have enough clusters to overflow this */
686         clusters = (unsigned int)(bytes >> cl_bits);
687
688         return clusters;
689 }
690
691 static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
692                                          u64 bytes)
693 {
694         bytes += sb->s_blocksize - 1;
695         return bytes >> sb->s_blocksize_bits;
696 }
697
698 static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
699                                           u32 clusters)
700 {
701         return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
702 }
703
704 static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
705                                                u64 blocks)
706 {
707         int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
708         unsigned int clusters;
709
710         clusters = ocfs2_blocks_to_clusters(sb, blocks);
711         return (u64)clusters << bits;
712 }
713
714 static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
715                                                 u64 bytes)
716 {
717         int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
718         unsigned int clusters;
719
720         clusters = ocfs2_clusters_for_bytes(sb, bytes);
721         return (u64)clusters << cl_bits;
722 }
723
724 static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
725                                               u64 bytes)
726 {
727         u64 blocks;
728
729         blocks = ocfs2_blocks_for_bytes(sb, bytes);
730         return blocks << sb->s_blocksize_bits;
731 }
732
733 static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
734 {
735         return (unsigned long)((bytes + 511) >> 9);
736 }
737
738 static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
739                                                         unsigned long pg_index)
740 {
741         u32 clusters = pg_index;
742         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
743
744         if (unlikely(PAGE_CACHE_SHIFT > cbits))
745                 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
746         else if (PAGE_CACHE_SHIFT < cbits)
747                 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
748
749         return clusters;
750 }
751
752 /*
753  * Find the 1st page index which covers the given clusters.
754  */
755 static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
756                                                         u32 clusters)
757 {
758         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
759         pgoff_t index = clusters;
760
761         if (PAGE_CACHE_SHIFT > cbits) {
762                 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
763         } else if (PAGE_CACHE_SHIFT < cbits) {
764                 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
765         }
766
767         return index;
768 }
769
770 static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
771 {
772         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
773         unsigned int pages_per_cluster = 1;
774
775         if (PAGE_CACHE_SHIFT < cbits)
776                 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
777
778         return pages_per_cluster;
779 }
780
781 static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
782                                                        unsigned int megs)
783 {
784         BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
785
786         return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
787 }
788
789 static inline unsigned int ocfs2_clusters_to_megabytes(struct super_block *sb,
790                                                        unsigned int clusters)
791 {
792         return clusters >> (20 - OCFS2_SB(sb)->s_clustersize_bits);
793 }
794
795 static inline void _ocfs2_set_bit(unsigned int bit, unsigned long *bitmap)
796 {
797         ext2_set_bit(bit, bitmap);
798 }
799 #define ocfs2_set_bit(bit, addr) _ocfs2_set_bit((bit), (unsigned long *)(addr))
800
801 static inline void _ocfs2_clear_bit(unsigned int bit, unsigned long *bitmap)
802 {
803         ext2_clear_bit(bit, bitmap);
804 }
805 #define ocfs2_clear_bit(bit, addr) _ocfs2_clear_bit((bit), (unsigned long *)(addr))
806
807 #define ocfs2_test_bit ext2_test_bit
808 #define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
809 #define ocfs2_find_next_bit ext2_find_next_bit
810 #endif  /* OCFS2_H */
811