xref: /openbmc/linux/fs/ocfs2/ocfs2.h (revision 09cbfeaf)
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 
176 	unsigned long		 l_flags;
177 	char                     l_name[OCFS2_LOCK_ID_MAX_LEN];
178 	unsigned int             l_ro_holders;
179 	unsigned int             l_ex_holders;
180 	signed char		 l_level;
181 	signed char		 l_requested;
182 	signed char		 l_blocking;
183 
184 	/* Data packed - type enum ocfs2_lock_type */
185 	unsigned char            l_type;
186 
187 	/* used from AST/BAST funcs. */
188 	/* Data packed - enum type ocfs2_ast_action */
189 	unsigned char            l_action;
190 	/* Data packed - enum type ocfs2_unlock_action */
191 	unsigned char            l_unlock_action;
192 	unsigned int             l_pending_gen;
193 
194 	spinlock_t               l_lock;
195 
196 	struct ocfs2_dlm_lksb    l_lksb;
197 
198 	wait_queue_head_t        l_event;
199 
200 	struct list_head         l_debug_list;
201 
202 #ifdef CONFIG_OCFS2_FS_STATS
203 	struct ocfs2_lock_stats  l_lock_prmode;		/* PR mode stats */
204 	u32                      l_lock_refresh;	/* Disk refreshes */
205 	struct ocfs2_lock_stats  l_lock_exmode;		/* EX mode stats */
206 #endif
207 #ifdef CONFIG_DEBUG_LOCK_ALLOC
208 	struct lockdep_map	 l_lockdep_map;
209 #endif
210 };
211 
212 enum ocfs2_orphan_reco_type {
213 	ORPHAN_NO_NEED_TRUNCATE = 0,
214 	ORPHAN_NEED_TRUNCATE,
215 };
216 
217 enum ocfs2_orphan_scan_state {
218 	ORPHAN_SCAN_ACTIVE,
219 	ORPHAN_SCAN_INACTIVE
220 };
221 
222 struct ocfs2_orphan_scan {
223 	struct mutex 		os_lock;
224 	struct ocfs2_super 	*os_osb;
225 	struct ocfs2_lock_res 	os_lockres;     /* lock to synchronize scans */
226 	struct delayed_work 	os_orphan_scan_work;
227 	struct timespec		os_scantime;  /* time this node ran the scan */
228 	u32			os_count;      /* tracks node specific scans */
229 	u32  			os_seqno;       /* tracks cluster wide scans */
230 	atomic_t		os_state;              /* ACTIVE or INACTIVE */
231 };
232 
233 struct ocfs2_dlm_debug {
234 	struct kref d_refcnt;
235 	struct dentry *d_locking_state;
236 	struct list_head d_lockres_tracking;
237 };
238 
239 enum ocfs2_vol_state
240 {
241 	VOLUME_INIT = 0,
242 	VOLUME_MOUNTED,
243 	VOLUME_MOUNTED_QUOTAS,
244 	VOLUME_DISMOUNTED,
245 	VOLUME_DISABLED
246 };
247 
248 struct ocfs2_alloc_stats
249 {
250 	atomic_t moves;
251 	atomic_t local_data;
252 	atomic_t bitmap_data;
253 	atomic_t bg_allocs;
254 	atomic_t bg_extends;
255 };
256 
257 enum ocfs2_local_alloc_state
258 {
259 	OCFS2_LA_UNUSED = 0,	/* Local alloc will never be used for
260 				 * this mountpoint. */
261 	OCFS2_LA_ENABLED,	/* Local alloc is in use. */
262 	OCFS2_LA_THROTTLED,	/* Local alloc is in use, but number
263 				 * of bits has been reduced. */
264 	OCFS2_LA_DISABLED	/* Local alloc has temporarily been
265 				 * disabled. */
266 };
267 
268 enum ocfs2_mount_options
269 {
270 	OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Local heartbeat */
271 	OCFS2_MOUNT_BARRIER = 1 << 1,	/* Use block barriers */
272 	OCFS2_MOUNT_NOINTR  = 1 << 2,   /* Don't catch signals */
273 	OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
274 	OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
275 	OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
276 	OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
277 	OCFS2_MOUNT_INODE64 = 1 << 7,	/* Allow inode numbers > 2^32 */
278 	OCFS2_MOUNT_POSIX_ACL = 1 << 8,	/* Force POSIX access control lists */
279 	OCFS2_MOUNT_NO_POSIX_ACL = 1 << 9,	/* Disable POSIX access
280 						   control lists */
281 	OCFS2_MOUNT_USRQUOTA = 1 << 10, /* We support user quotas */
282 	OCFS2_MOUNT_GRPQUOTA = 1 << 11, /* We support group quotas */
283 	OCFS2_MOUNT_COHERENCY_BUFFERED = 1 << 12, /* Allow concurrent O_DIRECT
284 						     writes */
285 	OCFS2_MOUNT_HB_NONE = 1 << 13, /* No heartbeat */
286 	OCFS2_MOUNT_HB_GLOBAL = 1 << 14, /* Global heartbeat */
287 
288 	OCFS2_MOUNT_JOURNAL_ASYNC_COMMIT = 1 << 15,  /* Journal Async Commit */
289 	OCFS2_MOUNT_ERRORS_CONT = 1 << 16, /* Return EIO to the calling process on error */
290 	OCFS2_MOUNT_ERRORS_ROFS = 1 << 17, /* Change filesystem to read-only on error */
291 };
292 
293 #define OCFS2_OSB_SOFT_RO	0x0001
294 #define OCFS2_OSB_HARD_RO	0x0002
295 #define OCFS2_OSB_ERROR_FS	0x0004
296 #define OCFS2_DEFAULT_ATIME_QUANTUM	60
297 
298 struct ocfs2_journal;
299 struct ocfs2_slot_info;
300 struct ocfs2_recovery_map;
301 struct ocfs2_replay_map;
302 struct ocfs2_quota_recovery;
303 struct ocfs2_super
304 {
305 	struct task_struct *commit_task;
306 	struct super_block *sb;
307 	struct inode *root_inode;
308 	struct inode *sys_root_inode;
309 	struct inode *global_system_inodes[NUM_GLOBAL_SYSTEM_INODES];
310 	struct inode **local_system_inodes;
311 
312 	struct ocfs2_slot_info *slot_info;
313 
314 	u32 *slot_recovery_generations;
315 
316 	spinlock_t node_map_lock;
317 
318 	u64 root_blkno;
319 	u64 system_dir_blkno;
320 	u64 bitmap_blkno;
321 	u32 bitmap_cpg;
322 	u8 *uuid;
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 three fields are for local node slot recovery during
391 	 * mount. */
392 	int dirty;
393 	struct ocfs2_dinode *local_alloc_copy;
394 	struct ocfs2_quota_recovery *quota_rec;
395 
396 	struct ocfs2_blockcheck_stats osb_ecc_stats;
397 	struct ocfs2_alloc_stats alloc_stats;
398 	char dev_str[20];		/* "major,minor" of the device */
399 
400 	u8 osb_stackflags;
401 
402 	char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
403 	char osb_cluster_name[OCFS2_CLUSTER_NAME_LEN + 1];
404 	struct ocfs2_cluster_connection *cconn;
405 	struct ocfs2_lock_res osb_super_lockres;
406 	struct ocfs2_lock_res osb_rename_lockres;
407 	struct ocfs2_lock_res osb_nfs_sync_lockres;
408 	struct ocfs2_dlm_debug *osb_dlm_debug;
409 
410 	struct dentry *osb_debug_root;
411 	struct dentry *osb_ctxt;
412 
413 	wait_queue_head_t recovery_event;
414 
415 	spinlock_t dc_task_lock;
416 	struct task_struct *dc_task;
417 	wait_queue_head_t dc_event;
418 	unsigned long dc_wake_sequence;
419 	unsigned long dc_work_sequence;
420 
421 	/*
422 	 * Any thread can add locks to the list, but the downconvert
423 	 * thread is the only one allowed to remove locks. Any change
424 	 * to this rule requires updating
425 	 * ocfs2_downconvert_thread_do_work().
426 	 */
427 	struct list_head blocked_lock_list;
428 	unsigned long blocked_lock_count;
429 
430 	/* List of dquot structures to drop last reference to */
431 	struct llist_head dquot_drop_list;
432 	struct work_struct dquot_drop_work;
433 
434 	wait_queue_head_t		osb_mount_event;
435 
436 	/* Truncate log info */
437 	struct inode			*osb_tl_inode;
438 	struct buffer_head		*osb_tl_bh;
439 	struct delayed_work		osb_truncate_log_wq;
440 	atomic_t			osb_tl_disable;
441 	/*
442 	 * How many clusters in our truncate log.
443 	 * It must be protected by osb_tl_inode->i_mutex.
444 	 */
445 	unsigned int truncated_clusters;
446 
447 	struct ocfs2_node_map		osb_recovering_orphan_dirs;
448 	unsigned int			*osb_orphan_wipes;
449 	wait_queue_head_t		osb_wipe_event;
450 
451 	struct ocfs2_orphan_scan	osb_orphan_scan;
452 
453 	/* used to protect metaecc calculation check of xattr. */
454 	spinlock_t osb_xattr_lock;
455 
456 	unsigned int			osb_dx_mask;
457 	u32				osb_dx_seed[4];
458 
459 	/* the group we used to allocate inodes. */
460 	u64				osb_inode_alloc_group;
461 
462 	/* rb tree root for refcount lock. */
463 	struct rb_root	osb_rf_lock_tree;
464 	struct ocfs2_refcount_tree *osb_ref_tree_lru;
465 
466 	struct mutex system_file_mutex;
467 
468 	/*
469 	 * OCFS2 needs to schedule several different types of work which
470 	 * require cluster locking, disk I/O, recovery waits, etc. Since these
471 	 * types of work tend to be heavy we avoid using the kernel events
472 	 * workqueue and schedule on our own.
473 	 */
474 	struct workqueue_struct *ocfs2_wq;
475 };
476 
477 #define OCFS2_SB(sb)	    ((struct ocfs2_super *)(sb)->s_fs_info)
478 
479 /* Useful typedef for passing around journal access functions */
480 typedef int (*ocfs2_journal_access_func)(handle_t *handle,
481 					 struct ocfs2_caching_info *ci,
482 					 struct buffer_head *bh, int type);
483 
484 static inline int ocfs2_should_order_data(struct inode *inode)
485 {
486 	if (!S_ISREG(inode->i_mode))
487 		return 0;
488 	if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
489 		return 0;
490 	return 1;
491 }
492 
493 static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
494 {
495 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
496 		return 1;
497 	return 0;
498 }
499 
500 static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
501 {
502 	/*
503 	 * Support for sparse files is a pre-requisite
504 	 */
505 	if (!ocfs2_sparse_alloc(osb))
506 		return 0;
507 
508 	if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
509 		return 1;
510 	return 0;
511 }
512 
513 static inline int ocfs2_supports_append_dio(struct ocfs2_super *osb)
514 {
515 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_APPEND_DIO)
516 		return 1;
517 	return 0;
518 }
519 
520 
521 static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
522 {
523 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
524 		return 1;
525 	return 0;
526 }
527 
528 static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
529 {
530 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
531 		return 1;
532 	return 0;
533 }
534 
535 static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
536 {
537 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
538 		return 1;
539 	return 0;
540 }
541 
542 static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
543 {
544 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
545 		return 1;
546 	return 0;
547 }
548 
549 static inline int ocfs2_supports_discontig_bg(struct ocfs2_super *osb)
550 {
551 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_DISCONTIG_BG)
552 		return 1;
553 	return 0;
554 }
555 
556 static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
557 {
558 	if (ocfs2_supports_indexed_dirs(osb))
559 		return OCFS2_DX_LINK_MAX;
560 	return OCFS2_LINK_MAX;
561 }
562 
563 static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
564 {
565 	u32 nlink = le16_to_cpu(di->i_links_count);
566 	u32 hi = le16_to_cpu(di->i_links_count_hi);
567 
568 	if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
569 		nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
570 
571 	return nlink;
572 }
573 
574 static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
575 {
576 	u16 lo, hi;
577 
578 	lo = nlink;
579 	hi = nlink >> OCFS2_LINKS_HI_SHIFT;
580 
581 	di->i_links_count = cpu_to_le16(lo);
582 	di->i_links_count_hi = cpu_to_le16(hi);
583 }
584 
585 static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
586 {
587 	u32 links = ocfs2_read_links_count(di);
588 
589 	links += n;
590 
591 	ocfs2_set_links_count(di, links);
592 }
593 
594 static inline int ocfs2_refcount_tree(struct ocfs2_super *osb)
595 {
596 	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE)
597 		return 1;
598 	return 0;
599 }
600 
601 /* set / clear functions because cluster events can make these happen
602  * in parallel so we want the transitions to be atomic. this also
603  * means that any future flags osb_flags must be protected by spinlock
604  * too! */
605 static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
606 				      unsigned long flag)
607 {
608 	spin_lock(&osb->osb_lock);
609 	osb->osb_flags |= flag;
610 	spin_unlock(&osb->osb_lock);
611 }
612 
613 static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
614 				     int hard)
615 {
616 	spin_lock(&osb->osb_lock);
617 	osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
618 	if (hard)
619 		osb->osb_flags |= OCFS2_OSB_HARD_RO;
620 	else
621 		osb->osb_flags |= OCFS2_OSB_SOFT_RO;
622 	spin_unlock(&osb->osb_lock);
623 }
624 
625 static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
626 {
627 	int ret;
628 
629 	spin_lock(&osb->osb_lock);
630 	ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
631 	spin_unlock(&osb->osb_lock);
632 
633 	return ret;
634 }
635 
636 static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
637 {
638 	int ret;
639 
640 	spin_lock(&osb->osb_lock);
641 	ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
642 	spin_unlock(&osb->osb_lock);
643 
644 	return ret;
645 }
646 
647 static inline int ocfs2_clusterinfo_valid(struct ocfs2_super *osb)
648 {
649 	return (osb->s_feature_incompat &
650 		(OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK |
651 		 OCFS2_FEATURE_INCOMPAT_CLUSTERINFO));
652 }
653 
654 static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
655 {
656 	if (ocfs2_clusterinfo_valid(osb) &&
657 	    memcmp(osb->osb_cluster_stack, OCFS2_CLASSIC_CLUSTER_STACK,
658 		   OCFS2_STACK_LABEL_LEN))
659 		return 1;
660 	return 0;
661 }
662 
663 static inline int ocfs2_o2cb_stack(struct ocfs2_super *osb)
664 {
665 	if (ocfs2_clusterinfo_valid(osb) &&
666 	    !memcmp(osb->osb_cluster_stack, OCFS2_CLASSIC_CLUSTER_STACK,
667 		   OCFS2_STACK_LABEL_LEN))
668 		return 1;
669 	return 0;
670 }
671 
672 static inline int ocfs2_cluster_o2cb_global_heartbeat(struct ocfs2_super *osb)
673 {
674 	return ocfs2_o2cb_stack(osb) &&
675 		(osb->osb_stackflags & OCFS2_CLUSTER_O2CB_GLOBAL_HEARTBEAT);
676 }
677 
678 static inline int ocfs2_mount_local(struct ocfs2_super *osb)
679 {
680 	return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
681 }
682 
683 static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
684 {
685 	return (osb->s_feature_incompat &
686 		OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
687 }
688 
689 
690 #define OCFS2_IS_VALID_DINODE(ptr)					\
691 	(!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
692 
693 #define OCFS2_IS_VALID_EXTENT_BLOCK(ptr)				\
694 	(!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
695 
696 #define OCFS2_IS_VALID_GROUP_DESC(ptr)					\
697 	(!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
698 
699 
700 #define OCFS2_IS_VALID_XATTR_BLOCK(ptr)					\
701 	(!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
702 
703 #define OCFS2_IS_VALID_DIR_TRAILER(ptr)					\
704 	(!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
705 
706 #define OCFS2_IS_VALID_DX_ROOT(ptr)					\
707 	(!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
708 
709 #define OCFS2_IS_VALID_DX_LEAF(ptr)					\
710 	(!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
711 
712 #define OCFS2_IS_VALID_REFCOUNT_BLOCK(ptr)				\
713 	(!strcmp((ptr)->rf_signature, OCFS2_REFCOUNT_BLOCK_SIGNATURE))
714 
715 static inline unsigned long ino_from_blkno(struct super_block *sb,
716 					   u64 blkno)
717 {
718 	return (unsigned long)(blkno & (u64)ULONG_MAX);
719 }
720 
721 static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
722 					   u32 clusters)
723 {
724 	int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
725 		sb->s_blocksize_bits;
726 
727 	return (u64)clusters << c_to_b_bits;
728 }
729 
730 static inline u32 ocfs2_clusters_for_blocks(struct super_block *sb,
731 		u64 blocks)
732 {
733 	int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
734 			sb->s_blocksize_bits;
735 
736 	blocks += (1 << b_to_c_bits) - 1;
737 	return (u32)(blocks >> b_to_c_bits);
738 }
739 
740 static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
741 					   u64 blocks)
742 {
743 	int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
744 		sb->s_blocksize_bits;
745 
746 	return (u32)(blocks >> b_to_c_bits);
747 }
748 
749 static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
750 						    u64 bytes)
751 {
752 	int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
753 	unsigned int clusters;
754 
755 	bytes += OCFS2_SB(sb)->s_clustersize - 1;
756 	/* OCFS2 just cannot have enough clusters to overflow this */
757 	clusters = (unsigned int)(bytes >> cl_bits);
758 
759 	return clusters;
760 }
761 
762 static inline unsigned int ocfs2_bytes_to_clusters(struct super_block *sb,
763 		u64 bytes)
764 {
765 	int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
766 	unsigned int clusters;
767 
768 	clusters = (unsigned int)(bytes >> cl_bits);
769 	return clusters;
770 }
771 
772 static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
773 					 u64 bytes)
774 {
775 	bytes += sb->s_blocksize - 1;
776 	return bytes >> sb->s_blocksize_bits;
777 }
778 
779 static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
780 					  u32 clusters)
781 {
782 	return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
783 }
784 
785 static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
786 					       u64 blocks)
787 {
788 	int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
789 	unsigned int clusters;
790 
791 	clusters = ocfs2_blocks_to_clusters(sb, blocks);
792 	return (u64)clusters << bits;
793 }
794 
795 static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
796 						u64 bytes)
797 {
798 	int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
799 	unsigned int clusters;
800 
801 	clusters = ocfs2_clusters_for_bytes(sb, bytes);
802 	return (u64)clusters << cl_bits;
803 }
804 
805 static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
806 					      u64 bytes)
807 {
808 	u64 blocks;
809 
810         blocks = ocfs2_blocks_for_bytes(sb, bytes);
811 	return blocks << sb->s_blocksize_bits;
812 }
813 
814 static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
815 {
816 	return (unsigned long)((bytes + 511) >> 9);
817 }
818 
819 static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
820 							unsigned long pg_index)
821 {
822 	u32 clusters = pg_index;
823 	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
824 
825 	if (unlikely(PAGE_SHIFT > cbits))
826 		clusters = pg_index << (PAGE_SHIFT - cbits);
827 	else if (PAGE_SHIFT < cbits)
828 		clusters = pg_index >> (cbits - PAGE_SHIFT);
829 
830 	return clusters;
831 }
832 
833 /*
834  * Find the 1st page index which covers the given clusters.
835  */
836 static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
837 							u32 clusters)
838 {
839 	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
840         pgoff_t index = clusters;
841 
842 	if (PAGE_SHIFT > cbits) {
843 		index = (pgoff_t)clusters >> (PAGE_SHIFT - cbits);
844 	} else if (PAGE_SHIFT < cbits) {
845 		index = (pgoff_t)clusters << (cbits - PAGE_SHIFT);
846 	}
847 
848 	return index;
849 }
850 
851 static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
852 {
853 	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
854 	unsigned int pages_per_cluster = 1;
855 
856 	if (PAGE_SHIFT < cbits)
857 		pages_per_cluster = 1 << (cbits - PAGE_SHIFT);
858 
859 	return pages_per_cluster;
860 }
861 
862 static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
863 						       unsigned int megs)
864 {
865 	BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
866 
867 	return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
868 }
869 
870 static inline unsigned int ocfs2_clusters_to_megabytes(struct super_block *sb,
871 						       unsigned int clusters)
872 {
873 	return clusters >> (20 - OCFS2_SB(sb)->s_clustersize_bits);
874 }
875 
876 static inline void _ocfs2_set_bit(unsigned int bit, unsigned long *bitmap)
877 {
878 	__set_bit_le(bit, bitmap);
879 }
880 #define ocfs2_set_bit(bit, addr) _ocfs2_set_bit((bit), (unsigned long *)(addr))
881 
882 static inline void _ocfs2_clear_bit(unsigned int bit, unsigned long *bitmap)
883 {
884 	__clear_bit_le(bit, bitmap);
885 }
886 #define ocfs2_clear_bit(bit, addr) _ocfs2_clear_bit((bit), (unsigned long *)(addr))
887 
888 #define ocfs2_test_bit test_bit_le
889 #define ocfs2_find_next_zero_bit find_next_zero_bit_le
890 #define ocfs2_find_next_bit find_next_bit_le
891 
892 static inline void *correct_addr_and_bit_unaligned(int *bit, void *addr)
893 {
894 #if BITS_PER_LONG == 64
895 	*bit += ((unsigned long) addr & 7UL) << 3;
896 	addr = (void *) ((unsigned long) addr & ~7UL);
897 #elif BITS_PER_LONG == 32
898 	*bit += ((unsigned long) addr & 3UL) << 3;
899 	addr = (void *) ((unsigned long) addr & ~3UL);
900 #else
901 #error "how many bits you are?!"
902 #endif
903 	return addr;
904 }
905 
906 static inline void ocfs2_set_bit_unaligned(int bit, void *bitmap)
907 {
908 	bitmap = correct_addr_and_bit_unaligned(&bit, bitmap);
909 	ocfs2_set_bit(bit, bitmap);
910 }
911 
912 static inline void ocfs2_clear_bit_unaligned(int bit, void *bitmap)
913 {
914 	bitmap = correct_addr_and_bit_unaligned(&bit, bitmap);
915 	ocfs2_clear_bit(bit, bitmap);
916 }
917 
918 static inline int ocfs2_test_bit_unaligned(int bit, void *bitmap)
919 {
920 	bitmap = correct_addr_and_bit_unaligned(&bit, bitmap);
921 	return ocfs2_test_bit(bit, bitmap);
922 }
923 
924 static inline int ocfs2_find_next_zero_bit_unaligned(void *bitmap, int max,
925 							int start)
926 {
927 	int fix = 0, ret, tmpmax;
928 	bitmap = correct_addr_and_bit_unaligned(&fix, bitmap);
929 	tmpmax = max + fix;
930 	start += fix;
931 
932 	ret = ocfs2_find_next_zero_bit(bitmap, tmpmax, start) - fix;
933 	if (ret > max)
934 		return max;
935 	return ret;
936 }
937 
938 #endif  /* OCFS2_H */
939 
940