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 #include <linux/jbd.h>
39 /* For union ocfs2_dlm_lksb */
40 #include "stackglue.h"
43 #include "ocfs2_lockid.h"
45 /* Most user visible OCFS2 inodes will have very few pieces of
46 * metadata, but larger files (including bitmaps, etc) must be taken
47 * into account when designing an access scheme. We allow a small
48 * amount of inlined blocks to be stored on an array and grow the
49 * structure into a rb tree when necessary. */
50 #define OCFS2_INODE_MAX_CACHE_ARRAY 2
52 struct ocfs2_caching_info {
53 unsigned int ci_num_cached;
55 sector_t ci_array[OCFS2_INODE_MAX_CACHE_ARRAY];
56 struct rb_root ci_tree;
60 /* this limits us to 256 nodes
61 * if we need more, we can do a kmalloc for the map */
62 #define OCFS2_NODE_MAP_MAX_NODES 256
63 struct ocfs2_node_map {
65 unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
68 enum ocfs2_ast_action {
69 OCFS2_AST_INVALID = 0,
72 OCFS2_AST_DOWNCONVERT,
75 /* actions for an unlockast function to take. */
76 enum ocfs2_unlock_action {
77 OCFS2_UNLOCK_INVALID = 0,
78 OCFS2_UNLOCK_CANCEL_CONVERT,
79 OCFS2_UNLOCK_DROP_LOCK,
82 /* ocfs2_lock_res->l_flags flags. */
83 #define OCFS2_LOCK_ATTACHED (0x00000001) /* have we initialized
85 #define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
87 #define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
89 #define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
90 #define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
91 #define OCFS2_LOCK_REFRESHING (0x00000020)
92 #define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
93 * for shutdown paths */
94 #define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
95 * when to skip queueing
99 #define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
100 #define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
101 #define OCFS2_LOCK_PENDING (0x00000400) /* This lockres is pending a
102 call to dlm_lock. Only
103 exists with BUSY set. */
105 struct ocfs2_lock_res_ops;
107 typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
109 struct ocfs2_lock_res {
111 struct ocfs2_lock_res_ops *l_ops;
114 struct list_head l_blocked_list;
115 struct list_head l_mask_waiters;
117 enum ocfs2_lock_type l_type;
118 unsigned long l_flags;
119 char l_name[OCFS2_LOCK_ID_MAX_LEN];
121 unsigned int l_ro_holders;
122 unsigned int l_ex_holders;
123 union ocfs2_dlm_lksb l_lksb;
125 /* used from AST/BAST funcs. */
126 enum ocfs2_ast_action l_action;
127 enum ocfs2_unlock_action l_unlock_action;
130 unsigned int l_pending_gen;
132 wait_queue_head_t l_event;
134 struct list_head l_debug_list;
137 struct ocfs2_dlm_debug {
138 struct kref d_refcnt;
139 struct dentry *d_locking_state;
140 struct list_head d_lockres_tracking;
151 struct ocfs2_alloc_stats
155 atomic_t bitmap_data;
160 enum ocfs2_local_alloc_state
167 enum ocfs2_mount_options
169 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
170 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
171 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
172 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
173 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
174 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
177 #define OCFS2_OSB_SOFT_RO 0x0001
178 #define OCFS2_OSB_HARD_RO 0x0002
179 #define OCFS2_OSB_ERROR_FS 0x0004
180 #define OCFS2_DEFAULT_ATIME_QUANTUM 60
182 struct ocfs2_journal;
183 struct ocfs2_slot_info;
184 struct ocfs2_recovery_map;
187 struct task_struct *commit_task;
188 struct super_block *sb;
189 struct inode *root_inode;
190 struct inode *sys_root_inode;
191 struct inode *system_inodes[NUM_SYSTEM_INODES];
193 struct ocfs2_slot_info *slot_info;
195 spinlock_t node_map_lock;
198 u64 system_dir_blkno;
204 u64 first_cluster_group_blkno;
207 u32 s_feature_compat;
208 u32 s_feature_incompat;
209 u32 s_feature_ro_compat;
211 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
212 * Could protect more on osb as it's very short lived.
215 u32 s_next_generation;
216 unsigned long osb_flags;
217 s16 s_inode_steal_slot;
218 atomic_t s_num_inodes_stolen;
220 unsigned long s_mount_opt;
221 unsigned int s_atime_quantum;
223 unsigned int max_slots;
224 unsigned int node_num;
229 int s_clustersize_bits;
232 struct mutex recovery_lock;
233 struct ocfs2_recovery_map *recovery_map;
234 struct task_struct *recovery_thread_task;
235 int disable_recovery;
236 wait_queue_head_t checkpoint_event;
237 atomic_t needs_checkpoint;
238 struct ocfs2_journal *journal;
239 unsigned long osb_commit_interval;
241 int local_alloc_size;
242 enum ocfs2_local_alloc_state local_alloc_state;
243 struct buffer_head *local_alloc_bh;
246 /* Next two fields are for local node slot recovery during
249 struct ocfs2_dinode *local_alloc_copy;
251 struct ocfs2_alloc_stats alloc_stats;
252 char dev_str[20]; /* "major,minor" of the device */
254 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
255 struct ocfs2_cluster_connection *cconn;
256 struct ocfs2_lock_res osb_super_lockres;
257 struct ocfs2_lock_res osb_rename_lockres;
258 struct ocfs2_dlm_debug *osb_dlm_debug;
260 struct dentry *osb_debug_root;
262 wait_queue_head_t recovery_event;
264 spinlock_t dc_task_lock;
265 struct task_struct *dc_task;
266 wait_queue_head_t dc_event;
267 unsigned long dc_wake_sequence;
268 unsigned long dc_work_sequence;
271 * Any thread can add locks to the list, but the downconvert
272 * thread is the only one allowed to remove locks. Any change
273 * to this rule requires updating
274 * ocfs2_downconvert_thread_do_work().
276 struct list_head blocked_lock_list;
277 unsigned long blocked_lock_count;
279 wait_queue_head_t osb_mount_event;
281 /* Truncate log info */
282 struct inode *osb_tl_inode;
283 struct buffer_head *osb_tl_bh;
284 struct delayed_work osb_truncate_log_wq;
286 struct ocfs2_node_map osb_recovering_orphan_dirs;
287 unsigned int *osb_orphan_wipes;
288 wait_queue_head_t osb_wipe_event;
291 #define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
293 static inline int ocfs2_should_order_data(struct inode *inode)
295 if (!S_ISREG(inode->i_mode))
297 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
302 static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
304 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
309 static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
312 * Support for sparse files is a pre-requisite
314 if (!ocfs2_sparse_alloc(osb))
317 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
322 static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
324 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
329 /* set / clear functions because cluster events can make these happen
330 * in parallel so we want the transitions to be atomic. this also
331 * means that any future flags osb_flags must be protected by spinlock
333 static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
336 spin_lock(&osb->osb_lock);
337 osb->osb_flags |= flag;
338 spin_unlock(&osb->osb_lock);
341 static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
344 spin_lock(&osb->osb_lock);
345 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
347 osb->osb_flags |= OCFS2_OSB_HARD_RO;
349 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
350 spin_unlock(&osb->osb_lock);
353 static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
357 spin_lock(&osb->osb_lock);
358 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
359 spin_unlock(&osb->osb_lock);
364 static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
368 spin_lock(&osb->osb_lock);
369 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
370 spin_unlock(&osb->osb_lock);
375 static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
377 return (osb->s_feature_incompat &
378 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
381 static inline int ocfs2_mount_local(struct ocfs2_super *osb)
383 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
386 static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
388 return (osb->s_feature_incompat &
389 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
393 #define OCFS2_IS_VALID_DINODE(ptr) \
394 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
396 #define OCFS2_RO_ON_INVALID_DINODE(__sb, __di) do { \
397 typeof(__di) ____di = (__di); \
398 ocfs2_error((__sb), \
399 "Dinode # %llu has bad signature %.*s", \
400 (unsigned long long)le64_to_cpu((____di)->i_blkno), 7, \
401 (____di)->i_signature); \
404 #define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
405 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
407 #define OCFS2_RO_ON_INVALID_EXTENT_BLOCK(__sb, __eb) do { \
408 typeof(__eb) ____eb = (__eb); \
409 ocfs2_error((__sb), \
410 "Extent Block # %llu has bad signature %.*s", \
411 (unsigned long long)le64_to_cpu((____eb)->h_blkno), 7, \
412 (____eb)->h_signature); \
415 #define OCFS2_IS_VALID_GROUP_DESC(ptr) \
416 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
418 #define OCFS2_RO_ON_INVALID_GROUP_DESC(__sb, __gd) do { \
419 typeof(__gd) ____gd = (__gd); \
420 ocfs2_error((__sb), \
421 "Group Descriptor # %llu has bad signature %.*s", \
422 (unsigned long long)le64_to_cpu((____gd)->bg_blkno), 7, \
423 (____gd)->bg_signature); \
426 static inline unsigned long ino_from_blkno(struct super_block *sb,
429 return (unsigned long)(blkno & (u64)ULONG_MAX);
432 static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
435 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
436 sb->s_blocksize_bits;
438 return (u64)clusters << c_to_b_bits;
441 static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
444 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
445 sb->s_blocksize_bits;
447 return (u32)(blocks >> b_to_c_bits);
450 static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
453 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
454 unsigned int clusters;
456 bytes += OCFS2_SB(sb)->s_clustersize - 1;
457 /* OCFS2 just cannot have enough clusters to overflow this */
458 clusters = (unsigned int)(bytes >> cl_bits);
463 static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
466 bytes += sb->s_blocksize - 1;
467 return bytes >> sb->s_blocksize_bits;
470 static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
473 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
476 static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
479 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
480 unsigned int clusters;
482 clusters = ocfs2_clusters_for_bytes(sb, bytes);
483 return (u64)clusters << cl_bits;
486 static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
491 blocks = ocfs2_blocks_for_bytes(sb, bytes);
492 return blocks << sb->s_blocksize_bits;
495 static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
497 return (unsigned long)((bytes + 511) >> 9);
500 static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
501 unsigned long pg_index)
503 u32 clusters = pg_index;
504 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
506 if (unlikely(PAGE_CACHE_SHIFT > cbits))
507 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
508 else if (PAGE_CACHE_SHIFT < cbits)
509 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
515 * Find the 1st page index which covers the given clusters.
517 static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
520 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
521 pgoff_t index = clusters;
523 if (PAGE_CACHE_SHIFT > cbits) {
524 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
525 } else if (PAGE_CACHE_SHIFT < cbits) {
526 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
532 static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
534 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
535 unsigned int pages_per_cluster = 1;
537 if (PAGE_CACHE_SHIFT < cbits)
538 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
540 return pages_per_cluster;
543 static inline void ocfs2_init_inode_steal_slot(struct ocfs2_super *osb)
545 spin_lock(&osb->osb_lock);
546 osb->s_inode_steal_slot = OCFS2_INVALID_SLOT;
547 spin_unlock(&osb->osb_lock);
548 atomic_set(&osb->s_num_inodes_stolen, 0);
551 static inline void ocfs2_set_inode_steal_slot(struct ocfs2_super *osb,
554 spin_lock(&osb->osb_lock);
555 osb->s_inode_steal_slot = slot;
556 spin_unlock(&osb->osb_lock);
559 static inline s16 ocfs2_get_inode_steal_slot(struct ocfs2_super *osb)
563 spin_lock(&osb->osb_lock);
564 slot = osb->s_inode_steal_slot;
565 spin_unlock(&osb->osb_lock);
570 #define ocfs2_set_bit ext2_set_bit
571 #define ocfs2_clear_bit ext2_clear_bit
572 #define ocfs2_test_bit ext2_test_bit
573 #define ocfs2_find_next_zero_bit ext2_find_next_zero_bit