1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
6 * Defines macros and structures used in OCFS2
8 * Copyright (C) 2002, 2004 Oracle. All rights reserved.
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.
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.
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.
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 #ifndef CONFIG_OCFS2_COMPAT_JBD
38 # include <linux/jbd2.h>
40 # include <linux/jbd.h>
41 # include "ocfs2_jbd_compat.h"
44 /* For union ocfs2_dlm_lksb */
45 #include "stackglue.h"
48 #include "ocfs2_lockid.h"
50 /* Most user visible OCFS2 inodes will have very few pieces of
51 * metadata, but larger files (including bitmaps, etc) must be taken
52 * into account when designing an access scheme. We allow a small
53 * amount of inlined blocks to be stored on an array and grow the
54 * structure into a rb tree when necessary. */
55 #define OCFS2_INODE_MAX_CACHE_ARRAY 2
57 struct ocfs2_caching_info {
58 unsigned int ci_num_cached;
60 sector_t ci_array[OCFS2_INODE_MAX_CACHE_ARRAY];
61 struct rb_root ci_tree;
65 /* this limits us to 256 nodes
66 * if we need more, we can do a kmalloc for the map */
67 #define OCFS2_NODE_MAP_MAX_NODES 256
68 struct ocfs2_node_map {
70 unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
73 enum ocfs2_ast_action {
74 OCFS2_AST_INVALID = 0,
77 OCFS2_AST_DOWNCONVERT,
80 /* actions for an unlockast function to take. */
81 enum ocfs2_unlock_action {
82 OCFS2_UNLOCK_INVALID = 0,
83 OCFS2_UNLOCK_CANCEL_CONVERT,
84 OCFS2_UNLOCK_DROP_LOCK,
87 /* ocfs2_lock_res->l_flags flags. */
88 #define OCFS2_LOCK_ATTACHED (0x00000001) /* we have initialized
90 #define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
92 #define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
94 #define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
95 #define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
96 #define OCFS2_LOCK_REFRESHING (0x00000020)
97 #define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
98 * for shutdown paths */
99 #define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
100 * when to skip queueing
101 * a lock because it's
104 #define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
105 #define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
106 #define OCFS2_LOCK_PENDING (0x00000400) /* This lockres is pending a
107 call to dlm_lock. Only
108 exists with BUSY set. */
110 struct ocfs2_lock_res_ops;
112 typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
114 struct ocfs2_lock_res {
116 struct ocfs2_lock_res_ops *l_ops;
119 struct list_head l_blocked_list;
120 struct list_head l_mask_waiters;
122 enum ocfs2_lock_type l_type;
123 unsigned long l_flags;
124 char l_name[OCFS2_LOCK_ID_MAX_LEN];
126 unsigned int l_ro_holders;
127 unsigned int l_ex_holders;
128 union ocfs2_dlm_lksb l_lksb;
130 /* used from AST/BAST funcs. */
131 enum ocfs2_ast_action l_action;
132 enum ocfs2_unlock_action l_unlock_action;
135 unsigned int l_pending_gen;
137 wait_queue_head_t l_event;
139 struct list_head l_debug_list;
141 #ifdef CONFIG_OCFS2_FS_STATS
142 unsigned long long l_lock_num_prmode; /* PR acquires */
143 unsigned long long l_lock_num_exmode; /* EX acquires */
144 unsigned int l_lock_num_prmode_failed; /* Failed PR gets */
145 unsigned int l_lock_num_exmode_failed; /* Failed EX gets */
146 unsigned long long l_lock_total_prmode; /* Tot wait for PR */
147 unsigned long long l_lock_total_exmode; /* Tot wait for EX */
148 unsigned int l_lock_max_prmode; /* Max wait for PR */
149 unsigned int l_lock_max_exmode; /* Max wait for EX */
150 unsigned int l_lock_refresh; /* Disk refreshes */
154 struct ocfs2_orphan_scan {
155 struct mutex os_lock;
156 struct ocfs2_super *os_osb;
157 struct ocfs2_lock_res os_lockres; /* lock to synchronize scans */
158 struct delayed_work os_orphan_scan_work;
159 struct timespec os_scantime; /* time this node ran the scan */
160 u32 os_count; /* tracks node specific scans */
161 u32 os_seqno; /* tracks cluster wide scans */
164 struct ocfs2_dlm_debug {
165 struct kref d_refcnt;
166 struct dentry *d_locking_state;
167 struct list_head d_lockres_tracking;
174 VOLUME_MOUNTED_QUOTAS,
179 struct ocfs2_alloc_stats
183 atomic_t bitmap_data;
188 enum ocfs2_local_alloc_state
190 OCFS2_LA_UNUSED = 0, /* Local alloc will never be used for
191 * this mountpoint. */
192 OCFS2_LA_ENABLED, /* Local alloc is in use. */
193 OCFS2_LA_THROTTLED, /* Local alloc is in use, but number
194 * of bits has been reduced. */
195 OCFS2_LA_DISABLED /* Local alloc has temporarily been
199 enum ocfs2_mount_options
201 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
202 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
203 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
204 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
205 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
206 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
207 OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
208 OCFS2_MOUNT_INODE64 = 1 << 7, /* Allow inode numbers > 2^32 */
209 OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* POSIX access control lists */
210 OCFS2_MOUNT_USRQUOTA = 1 << 9, /* We support user quotas */
211 OCFS2_MOUNT_GRPQUOTA = 1 << 10, /* We support group quotas */
214 #define OCFS2_OSB_SOFT_RO 0x0001
215 #define OCFS2_OSB_HARD_RO 0x0002
216 #define OCFS2_OSB_ERROR_FS 0x0004
217 #define OCFS2_DEFAULT_ATIME_QUANTUM 60
219 struct ocfs2_journal;
220 struct ocfs2_slot_info;
221 struct ocfs2_recovery_map;
222 struct ocfs2_replay_map;
223 struct ocfs2_quota_recovery;
224 struct ocfs2_dentry_lock;
227 struct task_struct *commit_task;
228 struct super_block *sb;
229 struct inode *root_inode;
230 struct inode *sys_root_inode;
231 struct inode *system_inodes[NUM_SYSTEM_INODES];
233 struct ocfs2_slot_info *slot_info;
235 u32 *slot_recovery_generations;
237 spinlock_t node_map_lock;
240 u64 system_dir_blkno;
247 u64 first_cluster_group_blkno;
250 u32 s_feature_compat;
251 u32 s_feature_incompat;
252 u32 s_feature_ro_compat;
254 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
255 * Could protect more on osb as it's very short lived.
258 u32 s_next_generation;
259 unsigned long osb_flags;
260 s16 s_inode_steal_slot;
261 atomic_t s_num_inodes_stolen;
263 unsigned long s_mount_opt;
264 unsigned int s_atime_quantum;
266 unsigned int max_slots;
267 unsigned int node_num;
272 int s_clustersize_bits;
273 unsigned int s_xattr_inline_size;
276 struct mutex recovery_lock;
277 struct ocfs2_recovery_map *recovery_map;
278 struct ocfs2_replay_map *replay_map;
279 struct task_struct *recovery_thread_task;
280 int disable_recovery;
281 wait_queue_head_t checkpoint_event;
282 atomic_t needs_checkpoint;
283 struct ocfs2_journal *journal;
284 unsigned long osb_commit_interval;
286 struct delayed_work la_enable_wq;
289 * Must hold local alloc i_mutex and osb->osb_lock to change
290 * local_alloc_bits. Reads can be done under either lock.
292 unsigned int local_alloc_bits;
293 unsigned int local_alloc_default_bits;
295 enum ocfs2_local_alloc_state local_alloc_state; /* protected
298 struct buffer_head *local_alloc_bh;
302 /* Next three fields are for local node slot recovery during
305 struct ocfs2_dinode *local_alloc_copy;
306 struct ocfs2_quota_recovery *quota_rec;
308 struct ocfs2_alloc_stats alloc_stats;
309 char dev_str[20]; /* "major,minor" of the device */
311 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
312 struct ocfs2_cluster_connection *cconn;
313 struct ocfs2_lock_res osb_super_lockres;
314 struct ocfs2_lock_res osb_rename_lockres;
315 struct ocfs2_lock_res osb_nfs_sync_lockres;
316 struct ocfs2_dlm_debug *osb_dlm_debug;
318 struct dentry *osb_debug_root;
319 struct dentry *osb_ctxt;
321 wait_queue_head_t recovery_event;
323 spinlock_t dc_task_lock;
324 struct task_struct *dc_task;
325 wait_queue_head_t dc_event;
326 unsigned long dc_wake_sequence;
327 unsigned long dc_work_sequence;
330 * Any thread can add locks to the list, but the downconvert
331 * thread is the only one allowed to remove locks. Any change
332 * to this rule requires updating
333 * ocfs2_downconvert_thread_do_work().
335 struct list_head blocked_lock_list;
336 unsigned long blocked_lock_count;
338 /* List of dentry locks to release. Anyone can add locks to
339 * the list, ocfs2_wq processes the list */
340 struct ocfs2_dentry_lock *dentry_lock_list;
341 struct work_struct dentry_lock_work;
343 wait_queue_head_t osb_mount_event;
345 /* Truncate log info */
346 struct inode *osb_tl_inode;
347 struct buffer_head *osb_tl_bh;
348 struct delayed_work osb_truncate_log_wq;
350 struct ocfs2_node_map osb_recovering_orphan_dirs;
351 unsigned int *osb_orphan_wipes;
352 wait_queue_head_t osb_wipe_event;
354 struct ocfs2_orphan_scan osb_orphan_scan;
356 /* used to protect metaecc calculation check of xattr. */
357 spinlock_t osb_xattr_lock;
359 unsigned int osb_dx_mask;
362 /* the group we used to allocate inodes. */
363 u64 osb_inode_alloc_group;
366 #define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
368 /* Useful typedef for passing around journal access functions */
369 typedef int (*ocfs2_journal_access_func)(handle_t *handle, struct inode *inode,
370 struct buffer_head *bh, int type);
372 static inline int ocfs2_should_order_data(struct inode *inode)
374 if (!S_ISREG(inode->i_mode))
376 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
381 static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
383 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
388 static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
391 * Support for sparse files is a pre-requisite
393 if (!ocfs2_sparse_alloc(osb))
396 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
401 static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
403 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
408 static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
410 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
415 static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
417 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
422 static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
424 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
429 static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
431 if (ocfs2_supports_indexed_dirs(osb))
432 return OCFS2_DX_LINK_MAX;
433 return OCFS2_LINK_MAX;
436 static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
438 u32 nlink = le16_to_cpu(di->i_links_count);
439 u32 hi = le16_to_cpu(di->i_links_count_hi);
441 if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
442 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
447 static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
452 hi = nlink >> OCFS2_LINKS_HI_SHIFT;
454 di->i_links_count = cpu_to_le16(lo);
455 di->i_links_count_hi = cpu_to_le16(hi);
458 static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
460 u32 links = ocfs2_read_links_count(di);
464 ocfs2_set_links_count(di, links);
467 /* set / clear functions because cluster events can make these happen
468 * in parallel so we want the transitions to be atomic. this also
469 * means that any future flags osb_flags must be protected by spinlock
471 static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
474 spin_lock(&osb->osb_lock);
475 osb->osb_flags |= flag;
476 spin_unlock(&osb->osb_lock);
479 static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
482 spin_lock(&osb->osb_lock);
483 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
485 osb->osb_flags |= OCFS2_OSB_HARD_RO;
487 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
488 spin_unlock(&osb->osb_lock);
491 static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
495 spin_lock(&osb->osb_lock);
496 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
497 spin_unlock(&osb->osb_lock);
502 static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
506 spin_lock(&osb->osb_lock);
507 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
508 spin_unlock(&osb->osb_lock);
513 static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
515 return (osb->s_feature_incompat &
516 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
519 static inline int ocfs2_mount_local(struct ocfs2_super *osb)
521 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
524 static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
526 return (osb->s_feature_incompat &
527 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
531 #define OCFS2_IS_VALID_DINODE(ptr) \
532 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
534 #define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
535 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
537 #define OCFS2_IS_VALID_GROUP_DESC(ptr) \
538 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
541 #define OCFS2_IS_VALID_XATTR_BLOCK(ptr) \
542 (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
544 #define OCFS2_IS_VALID_DIR_TRAILER(ptr) \
545 (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
547 #define OCFS2_IS_VALID_DX_ROOT(ptr) \
548 (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
550 #define OCFS2_IS_VALID_DX_LEAF(ptr) \
551 (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
553 static inline unsigned long ino_from_blkno(struct super_block *sb,
556 return (unsigned long)(blkno & (u64)ULONG_MAX);
559 static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
562 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
563 sb->s_blocksize_bits;
565 return (u64)clusters << c_to_b_bits;
568 static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
571 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
572 sb->s_blocksize_bits;
574 return (u32)(blocks >> b_to_c_bits);
577 static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
580 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
581 unsigned int clusters;
583 bytes += OCFS2_SB(sb)->s_clustersize - 1;
584 /* OCFS2 just cannot have enough clusters to overflow this */
585 clusters = (unsigned int)(bytes >> cl_bits);
590 static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
593 bytes += sb->s_blocksize - 1;
594 return bytes >> sb->s_blocksize_bits;
597 static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
600 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
603 static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
606 int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
607 unsigned int clusters;
609 clusters = ocfs2_blocks_to_clusters(sb, blocks);
610 return (u64)clusters << bits;
613 static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
616 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
617 unsigned int clusters;
619 clusters = ocfs2_clusters_for_bytes(sb, bytes);
620 return (u64)clusters << cl_bits;
623 static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
628 blocks = ocfs2_blocks_for_bytes(sb, bytes);
629 return blocks << sb->s_blocksize_bits;
632 static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
634 return (unsigned long)((bytes + 511) >> 9);
637 static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
638 unsigned long pg_index)
640 u32 clusters = pg_index;
641 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
643 if (unlikely(PAGE_CACHE_SHIFT > cbits))
644 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
645 else if (PAGE_CACHE_SHIFT < cbits)
646 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
652 * Find the 1st page index which covers the given clusters.
654 static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
657 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
658 pgoff_t index = clusters;
660 if (PAGE_CACHE_SHIFT > cbits) {
661 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
662 } else if (PAGE_CACHE_SHIFT < cbits) {
663 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
669 static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
671 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
672 unsigned int pages_per_cluster = 1;
674 if (PAGE_CACHE_SHIFT < cbits)
675 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
677 return pages_per_cluster;
680 static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
683 BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
685 return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
688 static inline void ocfs2_init_inode_steal_slot(struct ocfs2_super *osb)
690 spin_lock(&osb->osb_lock);
691 osb->s_inode_steal_slot = OCFS2_INVALID_SLOT;
692 spin_unlock(&osb->osb_lock);
693 atomic_set(&osb->s_num_inodes_stolen, 0);
696 static inline void ocfs2_set_inode_steal_slot(struct ocfs2_super *osb,
699 spin_lock(&osb->osb_lock);
700 osb->s_inode_steal_slot = slot;
701 spin_unlock(&osb->osb_lock);
704 static inline s16 ocfs2_get_inode_steal_slot(struct ocfs2_super *osb)
708 spin_lock(&osb->osb_lock);
709 slot = osb->s_inode_steal_slot;
710 spin_unlock(&osb->osb_lock);
715 #define ocfs2_set_bit ext2_set_bit
716 #define ocfs2_clear_bit ext2_clear_bit
717 #define ocfs2_test_bit ext2_test_bit
718 #define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
719 #define ocfs2_find_next_bit ext2_find_next_bit