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