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