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