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