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