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