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