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 /* For struct ocfs2_blockcheck_stats */
51 #include "blockcheck.h"
53 /* Most user visible OCFS2 inodes will have very few pieces of
54 * metadata, but larger files (including bitmaps, etc) must be taken
55 * into account when designing an access scheme. We allow a small
56 * amount of inlined blocks to be stored on an array and grow the
57 * structure into a rb tree when necessary. */
58 #define OCFS2_INODE_MAX_CACHE_ARRAY 2
60 struct ocfs2_caching_info {
61 unsigned int ci_num_cached;
63 sector_t ci_array[OCFS2_INODE_MAX_CACHE_ARRAY];
64 struct rb_root ci_tree;
68 /* this limits us to 256 nodes
69 * if we need more, we can do a kmalloc for the map */
70 #define OCFS2_NODE_MAP_MAX_NODES 256
71 struct ocfs2_node_map {
73 unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
76 enum ocfs2_ast_action {
77 OCFS2_AST_INVALID = 0,
80 OCFS2_AST_DOWNCONVERT,
83 /* actions for an unlockast function to take. */
84 enum ocfs2_unlock_action {
85 OCFS2_UNLOCK_INVALID = 0,
86 OCFS2_UNLOCK_CANCEL_CONVERT,
87 OCFS2_UNLOCK_DROP_LOCK,
90 /* ocfs2_lock_res->l_flags flags. */
91 #define OCFS2_LOCK_ATTACHED (0x00000001) /* we have initialized
93 #define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
95 #define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
97 #define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
98 #define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
99 #define OCFS2_LOCK_REFRESHING (0x00000020)
100 #define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
101 * for shutdown paths */
102 #define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
103 * when to skip queueing
104 * a lock because it's
107 #define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
108 #define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
109 #define OCFS2_LOCK_PENDING (0x00000400) /* This lockres is pending a
110 call to dlm_lock. Only
111 exists with BUSY set. */
113 struct ocfs2_lock_res_ops;
115 typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
117 struct ocfs2_lock_res {
119 struct ocfs2_lock_res_ops *l_ops;
122 struct list_head l_blocked_list;
123 struct list_head l_mask_waiters;
125 enum ocfs2_lock_type l_type;
126 unsigned long l_flags;
127 char l_name[OCFS2_LOCK_ID_MAX_LEN];
129 unsigned int l_ro_holders;
130 unsigned int l_ex_holders;
131 union ocfs2_dlm_lksb l_lksb;
133 /* used from AST/BAST funcs. */
134 enum ocfs2_ast_action l_action;
135 enum ocfs2_unlock_action l_unlock_action;
138 unsigned int l_pending_gen;
140 wait_queue_head_t l_event;
142 struct list_head l_debug_list;
144 #ifdef CONFIG_OCFS2_FS_STATS
145 unsigned long long l_lock_num_prmode; /* PR acquires */
146 unsigned long long l_lock_num_exmode; /* EX acquires */
147 unsigned int l_lock_num_prmode_failed; /* Failed PR gets */
148 unsigned int l_lock_num_exmode_failed; /* Failed EX gets */
149 unsigned long long l_lock_total_prmode; /* Tot wait for PR */
150 unsigned long long l_lock_total_exmode; /* Tot wait for EX */
151 unsigned int l_lock_max_prmode; /* Max wait for PR */
152 unsigned int l_lock_max_exmode; /* Max wait for EX */
153 unsigned int l_lock_refresh; /* Disk refreshes */
157 enum ocfs2_orphan_scan_state {
162 struct ocfs2_orphan_scan {
163 struct mutex os_lock;
164 struct ocfs2_super *os_osb;
165 struct ocfs2_lock_res os_lockres; /* lock to synchronize scans */
166 struct delayed_work os_orphan_scan_work;
167 struct timespec os_scantime; /* time this node ran the scan */
168 u32 os_count; /* tracks node specific scans */
169 u32 os_seqno; /* tracks cluster wide scans */
170 atomic_t os_state; /* ACTIVE or INACTIVE */
173 struct ocfs2_dlm_debug {
174 struct kref d_refcnt;
175 struct dentry *d_locking_state;
176 struct list_head d_lockres_tracking;
183 VOLUME_MOUNTED_QUOTAS,
188 struct ocfs2_alloc_stats
192 atomic_t bitmap_data;
197 enum ocfs2_local_alloc_state
199 OCFS2_LA_UNUSED = 0, /* Local alloc will never be used for
200 * this mountpoint. */
201 OCFS2_LA_ENABLED, /* Local alloc is in use. */
202 OCFS2_LA_THROTTLED, /* Local alloc is in use, but number
203 * of bits has been reduced. */
204 OCFS2_LA_DISABLED /* Local alloc has temporarily been
208 enum ocfs2_mount_options
210 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
211 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
212 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
213 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
214 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
215 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
216 OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
217 OCFS2_MOUNT_INODE64 = 1 << 7, /* Allow inode numbers > 2^32 */
218 OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* POSIX access control lists */
219 OCFS2_MOUNT_USRQUOTA = 1 << 9, /* We support user quotas */
220 OCFS2_MOUNT_GRPQUOTA = 1 << 10, /* We support group quotas */
223 #define OCFS2_OSB_SOFT_RO 0x0001
224 #define OCFS2_OSB_HARD_RO 0x0002
225 #define OCFS2_OSB_ERROR_FS 0x0004
226 #define OCFS2_DEFAULT_ATIME_QUANTUM 60
228 struct ocfs2_journal;
229 struct ocfs2_slot_info;
230 struct ocfs2_recovery_map;
231 struct ocfs2_replay_map;
232 struct ocfs2_quota_recovery;
233 struct ocfs2_dentry_lock;
236 struct task_struct *commit_task;
237 struct super_block *sb;
238 struct inode *root_inode;
239 struct inode *sys_root_inode;
240 struct inode *system_inodes[NUM_SYSTEM_INODES];
242 struct ocfs2_slot_info *slot_info;
244 u32 *slot_recovery_generations;
246 spinlock_t node_map_lock;
249 u64 system_dir_blkno;
256 u64 first_cluster_group_blkno;
259 u32 s_feature_compat;
260 u32 s_feature_incompat;
261 u32 s_feature_ro_compat;
263 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
264 * Could protect more on osb as it's very short lived.
267 u32 s_next_generation;
268 unsigned long osb_flags;
269 s16 s_inode_steal_slot;
270 atomic_t s_num_inodes_stolen;
272 unsigned long s_mount_opt;
273 unsigned int s_atime_quantum;
275 unsigned int max_slots;
276 unsigned int node_num;
281 int s_clustersize_bits;
282 unsigned int s_xattr_inline_size;
285 struct mutex recovery_lock;
286 struct ocfs2_recovery_map *recovery_map;
287 struct ocfs2_replay_map *replay_map;
288 struct task_struct *recovery_thread_task;
289 int disable_recovery;
290 wait_queue_head_t checkpoint_event;
291 atomic_t needs_checkpoint;
292 struct ocfs2_journal *journal;
293 unsigned long osb_commit_interval;
295 struct delayed_work la_enable_wq;
298 * Must hold local alloc i_mutex and osb->osb_lock to change
299 * local_alloc_bits. Reads can be done under either lock.
301 unsigned int local_alloc_bits;
302 unsigned int local_alloc_default_bits;
304 enum ocfs2_local_alloc_state local_alloc_state; /* protected
307 struct buffer_head *local_alloc_bh;
311 /* Next three fields are for local node slot recovery during
314 struct ocfs2_dinode *local_alloc_copy;
315 struct ocfs2_quota_recovery *quota_rec;
317 struct ocfs2_blockcheck_stats osb_ecc_stats;
318 struct ocfs2_alloc_stats alloc_stats;
319 char dev_str[20]; /* "major,minor" of the device */
321 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
322 struct ocfs2_cluster_connection *cconn;
323 struct ocfs2_lock_res osb_super_lockres;
324 struct ocfs2_lock_res osb_rename_lockres;
325 struct ocfs2_lock_res osb_nfs_sync_lockres;
326 struct ocfs2_dlm_debug *osb_dlm_debug;
328 struct dentry *osb_debug_root;
329 struct dentry *osb_ctxt;
331 wait_queue_head_t recovery_event;
333 spinlock_t dc_task_lock;
334 struct task_struct *dc_task;
335 wait_queue_head_t dc_event;
336 unsigned long dc_wake_sequence;
337 unsigned long dc_work_sequence;
340 * Any thread can add locks to the list, but the downconvert
341 * thread is the only one allowed to remove locks. Any change
342 * to this rule requires updating
343 * ocfs2_downconvert_thread_do_work().
345 struct list_head blocked_lock_list;
346 unsigned long blocked_lock_count;
348 /* List of dentry locks to release. Anyone can add locks to
349 * the list, ocfs2_wq processes the list */
350 struct ocfs2_dentry_lock *dentry_lock_list;
351 struct work_struct dentry_lock_work;
353 wait_queue_head_t osb_mount_event;
355 /* Truncate log info */
356 struct inode *osb_tl_inode;
357 struct buffer_head *osb_tl_bh;
358 struct delayed_work osb_truncate_log_wq;
360 struct ocfs2_node_map osb_recovering_orphan_dirs;
361 unsigned int *osb_orphan_wipes;
362 wait_queue_head_t osb_wipe_event;
364 struct ocfs2_orphan_scan osb_orphan_scan;
366 /* used to protect metaecc calculation check of xattr. */
367 spinlock_t osb_xattr_lock;
369 unsigned int osb_dx_mask;
372 /* the group we used to allocate inodes. */
373 u64 osb_inode_alloc_group;
376 #define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
378 /* Useful typedef for passing around journal access functions */
379 typedef int (*ocfs2_journal_access_func)(handle_t *handle, struct inode *inode,
380 struct buffer_head *bh, int type);
382 static inline int ocfs2_should_order_data(struct inode *inode)
384 if (!S_ISREG(inode->i_mode))
386 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
391 static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
393 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
398 static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
401 * Support for sparse files is a pre-requisite
403 if (!ocfs2_sparse_alloc(osb))
406 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
411 static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
413 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
418 static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
420 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
425 static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
427 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
432 static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
434 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
439 static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
441 if (ocfs2_supports_indexed_dirs(osb))
442 return OCFS2_DX_LINK_MAX;
443 return OCFS2_LINK_MAX;
446 static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
448 u32 nlink = le16_to_cpu(di->i_links_count);
449 u32 hi = le16_to_cpu(di->i_links_count_hi);
451 if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
452 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
457 static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
462 hi = nlink >> OCFS2_LINKS_HI_SHIFT;
464 di->i_links_count = cpu_to_le16(lo);
465 di->i_links_count_hi = cpu_to_le16(hi);
468 static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
470 u32 links = ocfs2_read_links_count(di);
474 ocfs2_set_links_count(di, links);
477 /* set / clear functions because cluster events can make these happen
478 * in parallel so we want the transitions to be atomic. this also
479 * means that any future flags osb_flags must be protected by spinlock
481 static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
484 spin_lock(&osb->osb_lock);
485 osb->osb_flags |= flag;
486 spin_unlock(&osb->osb_lock);
489 static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
492 spin_lock(&osb->osb_lock);
493 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
495 osb->osb_flags |= OCFS2_OSB_HARD_RO;
497 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
498 spin_unlock(&osb->osb_lock);
501 static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
505 spin_lock(&osb->osb_lock);
506 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
507 spin_unlock(&osb->osb_lock);
512 static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
516 spin_lock(&osb->osb_lock);
517 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
518 spin_unlock(&osb->osb_lock);
523 static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
525 return (osb->s_feature_incompat &
526 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
529 static inline int ocfs2_mount_local(struct ocfs2_super *osb)
531 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
534 static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
536 return (osb->s_feature_incompat &
537 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
541 #define OCFS2_IS_VALID_DINODE(ptr) \
542 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
544 #define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
545 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
547 #define OCFS2_IS_VALID_GROUP_DESC(ptr) \
548 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
551 #define OCFS2_IS_VALID_XATTR_BLOCK(ptr) \
552 (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
554 #define OCFS2_IS_VALID_DIR_TRAILER(ptr) \
555 (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
557 #define OCFS2_IS_VALID_DX_ROOT(ptr) \
558 (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
560 #define OCFS2_IS_VALID_DX_LEAF(ptr) \
561 (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
563 static inline unsigned long ino_from_blkno(struct super_block *sb,
566 return (unsigned long)(blkno & (u64)ULONG_MAX);
569 static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
572 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
573 sb->s_blocksize_bits;
575 return (u64)clusters << c_to_b_bits;
578 static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
581 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
582 sb->s_blocksize_bits;
584 return (u32)(blocks >> b_to_c_bits);
587 static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
590 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
591 unsigned int clusters;
593 bytes += OCFS2_SB(sb)->s_clustersize - 1;
594 /* OCFS2 just cannot have enough clusters to overflow this */
595 clusters = (unsigned int)(bytes >> cl_bits);
600 static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
603 bytes += sb->s_blocksize - 1;
604 return bytes >> sb->s_blocksize_bits;
607 static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
610 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
613 static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
616 int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
617 unsigned int clusters;
619 clusters = ocfs2_blocks_to_clusters(sb, blocks);
620 return (u64)clusters << bits;
623 static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
626 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
627 unsigned int clusters;
629 clusters = ocfs2_clusters_for_bytes(sb, bytes);
630 return (u64)clusters << cl_bits;
633 static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
638 blocks = ocfs2_blocks_for_bytes(sb, bytes);
639 return blocks << sb->s_blocksize_bits;
642 static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
644 return (unsigned long)((bytes + 511) >> 9);
647 static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
648 unsigned long pg_index)
650 u32 clusters = pg_index;
651 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
653 if (unlikely(PAGE_CACHE_SHIFT > cbits))
654 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
655 else if (PAGE_CACHE_SHIFT < cbits)
656 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
662 * Find the 1st page index which covers the given clusters.
664 static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
667 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
668 pgoff_t index = clusters;
670 if (PAGE_CACHE_SHIFT > cbits) {
671 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
672 } else if (PAGE_CACHE_SHIFT < cbits) {
673 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
679 static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
681 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
682 unsigned int pages_per_cluster = 1;
684 if (PAGE_CACHE_SHIFT < cbits)
685 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
687 return pages_per_cluster;
690 static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
693 BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
695 return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
698 static inline void ocfs2_init_inode_steal_slot(struct ocfs2_super *osb)
700 spin_lock(&osb->osb_lock);
701 osb->s_inode_steal_slot = OCFS2_INVALID_SLOT;
702 spin_unlock(&osb->osb_lock);
703 atomic_set(&osb->s_num_inodes_stolen, 0);
706 static inline void ocfs2_set_inode_steal_slot(struct ocfs2_super *osb,
709 spin_lock(&osb->osb_lock);
710 osb->s_inode_steal_slot = slot;
711 spin_unlock(&osb->osb_lock);
714 static inline s16 ocfs2_get_inode_steal_slot(struct ocfs2_super *osb)
718 spin_lock(&osb->osb_lock);
719 slot = osb->s_inode_steal_slot;
720 spin_unlock(&osb->osb_lock);
725 #define ocfs2_set_bit ext2_set_bit
726 #define ocfs2_clear_bit ext2_clear_bit
727 #define ocfs2_test_bit ext2_test_bit
728 #define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
729 #define ocfs2_find_next_bit ext2_find_next_bit