[linux.git] / fs / ocfs2 / ocfs2.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * ocfs2.h
 *
 * Defines macros and structures used in OCFS2
 *
 * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 */

#ifndef OCFS2_H
#define OCFS2_H

#include <linux/spinlock.h>
#include <linux/sched.h>
#include <linux/wait.h>
#include <linux/list.h>
#include <linux/rbtree.h>
#include <linux/workqueue.h>
#include <linux/kref.h>
#include <linux/mutex.h>
#include <linux/jbd.h>

#include "cluster/nodemanager.h"
#include "cluster/heartbeat.h"
#include "cluster/tcp.h"

#include "dlm/dlmapi.h"

#include "ocfs2_fs.h"
#include "ocfs2_lockid.h"

/* Most user visible OCFS2 inodes will have very few pieces of
 * metadata, but larger files (including bitmaps, etc) must be taken
 * into account when designing an access scheme. We allow a small
 * amount of inlined blocks to be stored on an array and grow the
 * structure into a rb tree when necessary. */
#define OCFS2_INODE_MAX_CACHE_ARRAY 2

struct ocfs2_caching_info {
	unsigned int		ci_num_cached;
	union {
		sector_t	ci_array[OCFS2_INODE_MAX_CACHE_ARRAY];
		struct rb_root	ci_tree;
	} ci_cache;
};

/* this limits us to 256 nodes
 * if we need more, we can do a kmalloc for the map */
#define OCFS2_NODE_MAP_MAX_NODES    256
struct ocfs2_node_map {
	u16 num_nodes;
	unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
};

enum ocfs2_ast_action {
	OCFS2_AST_INVALID = 0,
	OCFS2_AST_ATTACH,
	OCFS2_AST_CONVERT,
	OCFS2_AST_DOWNCONVERT,
};

/* actions for an unlockast function to take. */
enum ocfs2_unlock_action {
	OCFS2_UNLOCK_INVALID = 0,
	OCFS2_UNLOCK_CANCEL_CONVERT,
	OCFS2_UNLOCK_DROP_LOCK,
};

/* ocfs2_lock_res->l_flags flags. */
#define OCFS2_LOCK_ATTACHED      (0x00000001) /* have we initialized
					       * the lvb */
#define OCFS2_LOCK_BUSY          (0x00000002) /* we are currently in
					       * dlm_lock */
#define OCFS2_LOCK_BLOCKED       (0x00000004) /* blocked waiting to
					       * downconvert*/
#define OCFS2_LOCK_LOCAL         (0x00000008) /* newly created inode */
#define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
#define OCFS2_LOCK_REFRESHING    (0x00000020)
#define OCFS2_LOCK_INITIALIZED   (0x00000040) /* track initialization
					       * for shutdown paths */
#define OCFS2_LOCK_FREEING       (0x00000080) /* help dlmglue track
					       * when to skip queueing
					       * a lock because it's
					       * about to be
					       * dropped. */
#define OCFS2_LOCK_QUEUED        (0x00000100) /* queued for downconvert */
#define OCFS2_LOCK_NOCACHE       (0x00000200) /* don't use a holder count */

struct ocfs2_lock_res_ops;

typedef void (*ocfs2_lock_callback)(int status, unsigned long data);

struct ocfs2_lock_res {
	void                    *l_priv;
	struct ocfs2_lock_res_ops *l_ops;
	spinlock_t               l_lock;

	struct list_head         l_blocked_list;
	struct list_head         l_mask_waiters;

	enum ocfs2_lock_type     l_type;
	unsigned long		 l_flags;
	char                     l_name[OCFS2_LOCK_ID_MAX_LEN];
	int                      l_level;
	unsigned int             l_ro_holders;
	unsigned int             l_ex_holders;
	struct dlm_lockstatus    l_lksb;

	/* used from AST/BAST funcs. */
	enum ocfs2_ast_action    l_action;
	enum ocfs2_unlock_action l_unlock_action;
	int                      l_requested;
	int                      l_blocking;

	wait_queue_head_t        l_event;

	struct list_head         l_debug_list;
};

struct ocfs2_dlm_debug {
	struct kref d_refcnt;
	struct dentry *d_locking_state;
	struct list_head d_lockres_tracking;
};

enum ocfs2_vol_state
{
	VOLUME_INIT = 0,
	VOLUME_MOUNTED,
	VOLUME_DISMOUNTED,
	VOLUME_DISABLED
};

struct ocfs2_alloc_stats
{
	atomic_t moves;
	atomic_t local_data;
	atomic_t bitmap_data;
	atomic_t bg_allocs;
	atomic_t bg_extends;
};

enum ocfs2_local_alloc_state
{
	OCFS2_LA_UNUSED = 0,
	OCFS2_LA_ENABLED,
	OCFS2_LA_DISABLED
};

enum ocfs2_mount_options
{
	OCFS2_MOUNT_HB_LOCAL   = 1 << 0, /* Heartbeat started in local mode */
	OCFS2_MOUNT_BARRIER = 1 << 1,	/* Use block barriers */
	OCFS2_MOUNT_NOINTR  = 1 << 2,   /* Don't catch signals */
	OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
	OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
	OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
};

#define OCFS2_OSB_SOFT_RO	0x0001
#define OCFS2_OSB_HARD_RO	0x0002
#define OCFS2_OSB_ERROR_FS	0x0004
#define OCFS2_DEFAULT_ATIME_QUANTUM	60

struct ocfs2_journal;
struct ocfs2_super
{
	struct task_struct *commit_task;
	struct super_block *sb;
	struct inode *root_inode;
	struct inode *sys_root_inode;
	struct inode *system_inodes[NUM_SYSTEM_INODES];

	struct ocfs2_slot_info *slot_info;

	spinlock_t node_map_lock;
	struct ocfs2_node_map recovery_map;

	u64 root_blkno;
	u64 system_dir_blkno;
	u64 bitmap_blkno;
	u32 bitmap_cpg;
	u8 *uuid;
	char *uuid_str;
	u8 *vol_label;
	u64 first_cluster_group_blkno;
	u32 fs_generation;

	u32 s_feature_compat;
	u32 s_feature_incompat;
	u32 s_feature_ro_compat;

	/* Protects s_next_generaion, osb_flags. Could protect more on
	 * osb as it's very short lived. */
	spinlock_t osb_lock;
	u32 s_next_generation;
	unsigned long osb_flags;

	unsigned long s_mount_opt;
	unsigned int s_atime_quantum;

	u16 max_slots;
	s16 node_num;
	s16 slot_num;
	s16 preferred_slot;
	int s_sectsize_bits;
	int s_clustersize;
	int s_clustersize_bits;

	atomic_t vol_state;
	struct mutex recovery_lock;
	struct task_struct *recovery_thread_task;
	int disable_recovery;
	wait_queue_head_t checkpoint_event;
	atomic_t needs_checkpoint;
	struct ocfs2_journal *journal;
	unsigned long osb_commit_interval;

	int local_alloc_size;
	enum ocfs2_local_alloc_state local_alloc_state;
	struct buffer_head *local_alloc_bh;
	u64 la_last_gd;

	/* Next two fields are for local node slot recovery during
	 * mount. */
	int dirty;
	struct ocfs2_dinode *local_alloc_copy;

	struct ocfs2_alloc_stats alloc_stats;
	char dev_str[20];		/* "major,minor" of the device */

	struct dlm_ctxt *dlm;
	struct ocfs2_lock_res osb_super_lockres;
	struct ocfs2_lock_res osb_rename_lockres;
	struct dlm_eviction_cb osb_eviction_cb;
	struct ocfs2_dlm_debug *osb_dlm_debug;
	struct dlm_protocol_version osb_locking_proto;

	struct dentry *osb_debug_root;

	wait_queue_head_t recovery_event;

	spinlock_t dc_task_lock;
	struct task_struct *dc_task;
	wait_queue_head_t dc_event;
	unsigned long dc_wake_sequence;
	unsigned long dc_work_sequence;

	/*
	 * Any thread can add locks to the list, but the downconvert
	 * thread is the only one allowed to remove locks. Any change
	 * to this rule requires updating
	 * ocfs2_downconvert_thread_do_work().
	 */
	struct list_head blocked_lock_list;
	unsigned long blocked_lock_count;

	wait_queue_head_t		osb_mount_event;

	/* Truncate log info */
	struct inode			*osb_tl_inode;
	struct buffer_head		*osb_tl_bh;
	struct delayed_work		osb_truncate_log_wq;

	struct ocfs2_node_map		osb_recovering_orphan_dirs;
	unsigned int			*osb_orphan_wipes;
	wait_queue_head_t		osb_wipe_event;
};

#define OCFS2_SB(sb)	    ((struct ocfs2_super *)(sb)->s_fs_info)

static inline int ocfs2_should_order_data(struct inode *inode)
{
	if (!S_ISREG(inode->i_mode))
		return 0;
	if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
		return 0;
	return 1;
}

static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
{
	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
		return 1;
	return 0;
}

static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
{
	/*
	 * Support for sparse files is a pre-requisite
	 */
	if (!ocfs2_sparse_alloc(osb))
		return 0;

	if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
		return 1;
	return 0;
}

static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
{
	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
		return 1;
	return 0;
}

/* set / clear functions because cluster events can make these happen
 * in parallel so we want the transitions to be atomic. this also
 * means that any future flags osb_flags must be protected by spinlock
 * too! */
static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
				      unsigned long flag)
{
	spin_lock(&osb->osb_lock);
	osb->osb_flags |= flag;
	spin_unlock(&osb->osb_lock);
}

static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
				     int hard)
{
	spin_lock(&osb->osb_lock);
	osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
	if (hard)
		osb->osb_flags |= OCFS2_OSB_HARD_RO;
	else
		osb->osb_flags |= OCFS2_OSB_SOFT_RO;
	spin_unlock(&osb->osb_lock);
}

static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
{
	int ret;

	spin_lock(&osb->osb_lock);
	ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
	spin_unlock(&osb->osb_lock);

	return ret;
}

static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
{
	int ret;

	spin_lock(&osb->osb_lock);
	ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
	spin_unlock(&osb->osb_lock);

	return ret;
}

static inline int ocfs2_mount_local(struct ocfs2_super *osb)
{
	return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
}

#define OCFS2_IS_VALID_DINODE(ptr)					\
	(!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))

#define OCFS2_RO_ON_INVALID_DINODE(__sb, __di)	do {			\
	typeof(__di) ____di = (__di);					\
	ocfs2_error((__sb), 						\
		"Dinode # %llu has bad signature %.*s",			\
		(unsigned long long)le64_to_cpu((____di)->i_blkno), 7, 	\
		(____di)->i_signature);					\
} while (0)

#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr)				\
	(!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))

#define OCFS2_RO_ON_INVALID_EXTENT_BLOCK(__sb, __eb)	do {		\
	typeof(__eb) ____eb = (__eb);					\
	ocfs2_error((__sb), 						\
		"Extent Block # %llu has bad signature %.*s",		\
		(unsigned long long)le64_to_cpu((____eb)->h_blkno), 7,	\
		(____eb)->h_signature);					\
} while (0)

#define OCFS2_IS_VALID_GROUP_DESC(ptr)					\
	(!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))

#define OCFS2_RO_ON_INVALID_GROUP_DESC(__sb, __gd)	do {		\
	typeof(__gd) ____gd = (__gd);					\
		ocfs2_error((__sb),					\
		"Group Descriptor # %llu has bad signature %.*s",	\
		(unsigned long long)le64_to_cpu((____gd)->bg_blkno), 7, \
		(____gd)->bg_signature);				\
} while (0)

static inline unsigned long ino_from_blkno(struct super_block *sb,
					   u64 blkno)
{
	return (unsigned long)(blkno & (u64)ULONG_MAX);
}

static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
					   u32 clusters)
{
	int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
		sb->s_blocksize_bits;

	return (u64)clusters << c_to_b_bits;
}

static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
					   u64 blocks)
{
	int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
		sb->s_blocksize_bits;

	return (u32)(blocks >> b_to_c_bits);
}

static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
						    u64 bytes)
{
	int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
	unsigned int clusters;

	bytes += OCFS2_SB(sb)->s_clustersize - 1;
	/* OCFS2 just cannot have enough clusters to overflow this */
	clusters = (unsigned int)(bytes >> cl_bits);

	return clusters;
}

static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
					 u64 bytes)
{
	bytes += sb->s_blocksize - 1;
	return bytes >> sb->s_blocksize_bits;
}

static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
					  u32 clusters)
{
	return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
}

static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
						u64 bytes)
{
	int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
	unsigned int clusters;

	clusters = ocfs2_clusters_for_bytes(sb, bytes);
	return (u64)clusters << cl_bits;
}

static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
					      u64 bytes)
{
	u64 blocks;

        blocks = ocfs2_blocks_for_bytes(sb, bytes);
	return blocks << sb->s_blocksize_bits;
}

static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
{
	return (unsigned long)((bytes + 511) >> 9);
}

static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
							unsigned long pg_index)
{
	u32 clusters = pg_index;
	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;

	if (unlikely(PAGE_CACHE_SHIFT > cbits))
		clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
	else if (PAGE_CACHE_SHIFT < cbits)
		clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);

	return clusters;
}

/*
 * Find the 1st page index which covers the given clusters.
 */
static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
							u32 clusters)
{
	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
        pgoff_t index = clusters;

	if (PAGE_CACHE_SHIFT > cbits) {
		index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
	} else if (PAGE_CACHE_SHIFT < cbits) {
		index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
	}

	return index;
}

static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
{
	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
	unsigned int pages_per_cluster = 1;

	if (PAGE_CACHE_SHIFT < cbits)
		pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);

	return pages_per_cluster;
}

#define ocfs2_set_bit ext2_set_bit
#define ocfs2_clear_bit ext2_clear_bit
#define ocfs2_test_bit ext2_test_bit
#define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
#endif  /* OCFS2_H */
Commit	Line	Data
ccd979bd MF	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>
c74ec2f7	36	#include <linux/mutex.h>
1fabe148	37	#include <linux/jbd.h>
ccd979bd MF	38
	39	#include "cluster/nodemanager.h"
	40	#include "cluster/heartbeat.h"
	41	#include "cluster/tcp.h"
	42
	43	#include "dlm/dlmapi.h"
	44
	45	#include "ocfs2_fs.h"
ccd979bd MF	46	#include "ocfs2_lockid.h"
ccd979bd MF	47
ccd979bd MF	48	/* Most user visible OCFS2 inodes will have very few pieces of
	49	* metadata, but larger files (including bitmaps, etc) must be taken
	50	* into account when designing an access scheme. We allow a small
	51	* amount of inlined blocks to be stored on an array and grow the
	52	* structure into a rb tree when necessary. */
	53	#define OCFS2_INODE_MAX_CACHE_ARRAY 2
	54
	55	struct ocfs2_caching_info {
	56	unsigned int ci_num_cached;
	57	union {
	58	sector_t ci_array[OCFS2_INODE_MAX_CACHE_ARRAY];
	59	struct rb_root ci_tree;
	60	} ci_cache;
	61	};
	62
	63	/* this limits us to 256 nodes
	64	* if we need more, we can do a kmalloc for the map */
	65	#define OCFS2_NODE_MAP_MAX_NODES 256
	66	struct ocfs2_node_map {
	67	u16 num_nodes;
	68	unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
	69	};
	70
	71	enum ocfs2_ast_action {
	72	OCFS2_AST_INVALID = 0,
	73	OCFS2_AST_ATTACH,
	74	OCFS2_AST_CONVERT,
	75	OCFS2_AST_DOWNCONVERT,
	76	};
	77
	78	/* actions for an unlockast function to take. */
	79	enum ocfs2_unlock_action {
	80	OCFS2_UNLOCK_INVALID = 0,
	81	OCFS2_UNLOCK_CANCEL_CONVERT,
	82	OCFS2_UNLOCK_DROP_LOCK,
	83	};
	84
	85	/* ocfs2_lock_res->l_flags flags. */
	86	#define OCFS2_LOCK_ATTACHED (0x00000001) /* have we initialized
	87	* the lvb */
	88	#define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
	89	* dlm_lock */
	90	#define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
	91	* downconvert*/
	92	#define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
	93	#define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
	94	#define OCFS2_LOCK_REFRESHING (0x00000020)
	95	#define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
	96	* for shutdown paths */
	97	#define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
	98	* when to skip queueing
	99	* a lock because it's
	100	* about to be
	101	* dropped. */
	102	#define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
cf8e06f1	103	#define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
ccd979bd MF	104
	105	struct ocfs2_lock_res_ops;
	106
	107	typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
	108
	109	struct ocfs2_lock_res {
	110	void *l_priv;
	111	struct ocfs2_lock_res_ops *l_ops;
	112	spinlock_t l_lock;
	113
	114	struct list_head l_blocked_list;
	115	struct list_head l_mask_waiters;
	116
	117	enum ocfs2_lock_type l_type;
	118	unsigned long l_flags;
	119	char l_name[OCFS2_LOCK_ID_MAX_LEN];
	120	int l_level;
	121	unsigned int l_ro_holders;
	122	unsigned int l_ex_holders;
	123	struct dlm_lockstatus l_lksb;
	124
	125	/* used from AST/BAST funcs. */
	126	enum ocfs2_ast_action l_action;
	127	enum ocfs2_unlock_action l_unlock_action;
	128	int l_requested;
	129	int l_blocking;
	130
	131	wait_queue_head_t l_event;
	132
	133	struct list_head l_debug_list;
	134	};
	135
	136	struct ocfs2_dlm_debug {
	137	struct kref d_refcnt;
	138	struct dentry *d_locking_state;
	139	struct list_head d_lockres_tracking;
	140	};
	141
	142	enum ocfs2_vol_state
	143	{
	144	VOLUME_INIT = 0,
	145	VOLUME_MOUNTED,
	146	VOLUME_DISMOUNTED,
	147	VOLUME_DISABLED
	148	};
	149
	150	struct ocfs2_alloc_stats
	151	{
	152	atomic_t moves;
	153	atomic_t local_data;
	154	atomic_t bitmap_data;
	155	atomic_t bg_allocs;
	156	atomic_t bg_extends;
	157	};
	158
	159	enum ocfs2_local_alloc_state
	160	{
	161	OCFS2_LA_UNUSED = 0,
	162	OCFS2_LA_ENABLED,
	163	OCFS2_LA_DISABLED
	164	};
	165
	166	enum ocfs2_mount_options
	167	{
168	OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
169	OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
170	OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
171	OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
172	OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
53fc622b	173	OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
ccd979bd MF	174	};
	175
	176	#define OCFS2_OSB_SOFT_RO 0x0001
	177	#define OCFS2_OSB_HARD_RO 0x0002
	178	#define OCFS2_OSB_ERROR_FS 0x0004
7f1a37e3	179	#define OCFS2_DEFAULT_ATIME_QUANTUM 60
ccd979bd MF	180
ccd979bd MF	181	struct ocfs2_journal;
ccd979bd MF	182	struct ocfs2_super
ccd979bd MF	183	{
ccd979bd MF	184	struct task_struct *commit_task;
	185	struct super_block *sb;
	186	struct inode *root_inode;
	187	struct inode *sys_root_inode;
	188	struct inode *system_inodes[NUM_SYSTEM_INODES];
	189
	190	struct ocfs2_slot_info *slot_info;
	191
	192	spinlock_t node_map_lock;
ccd979bd	193	struct ocfs2_node_map recovery_map;
ccd979bd	194
ccd979bd MF	195	u64 root_blkno;
	196	u64 system_dir_blkno;
	197	u64 bitmap_blkno;
	198	u32 bitmap_cpg;
	199	u8 *uuid;
	200	char *uuid_str;
	201	u8 *vol_label;
	202	u64 first_cluster_group_blkno;
	203	u32 fs_generation;
	204
	205	u32 s_feature_compat;
	206	u32 s_feature_incompat;
	207	u32 s_feature_ro_compat;
	208
	209	/* Protects s_next_generaion, osb_flags. Could protect more on
	210	* osb as it's very short lived. */
	211	spinlock_t osb_lock;
	212	u32 s_next_generation;
	213	unsigned long osb_flags;
	214
	215	unsigned long s_mount_opt;
7f1a37e3	216	unsigned int s_atime_quantum;
ccd979bd MF	217
ccd979bd MF	218	u16 max_slots;
ccd979bd MF	219	s16 node_num;
ccd979bd MF	220	s16 slot_num;
baf4661a	221	s16 preferred_slot;
ccd979bd MF	222	int s_sectsize_bits;
	223	int s_clustersize;
	224	int s_clustersize_bits;
ccd979bd MF	225
ccd979bd MF	226	atomic_t vol_state;
c74ec2f7	227	struct mutex recovery_lock;
ccd979bd MF	228	struct task_struct *recovery_thread_task;
	229	int disable_recovery;
	230	wait_queue_head_t checkpoint_event;
	231	atomic_t needs_checkpoint;
	232	struct ocfs2_journal *journal;
d147b3d6	233	unsigned long osb_commit_interval;
ccd979bd	234
2fbe8d1e	235	int local_alloc_size;
ccd979bd MF	236	enum ocfs2_local_alloc_state local_alloc_state;
ccd979bd MF	237	struct buffer_head *local_alloc_bh;
883d4cae	238	u64 la_last_gd;
ccd979bd MF	239
	240	/* Next two fields are for local node slot recovery during
	241	* mount. */
	242	int dirty;
	243	struct ocfs2_dinode *local_alloc_copy;
	244
	245	struct ocfs2_alloc_stats alloc_stats;
	246	char dev_str[20]; /* "major,minor" of the device */
	247
	248	struct dlm_ctxt *dlm;
	249	struct ocfs2_lock_res osb_super_lockres;
	250	struct ocfs2_lock_res osb_rename_lockres;
	251	struct dlm_eviction_cb osb_eviction_cb;
	252	struct ocfs2_dlm_debug *osb_dlm_debug;
d24fbcda	253	struct dlm_protocol_version osb_locking_proto;
ccd979bd MF	254
	255	struct dentry *osb_debug_root;
	256
	257	wait_queue_head_t recovery_event;
	258
34d024f8 MF	259	spinlock_t dc_task_lock;
	260	struct task_struct *dc_task;
	261	wait_queue_head_t dc_event;
	262	unsigned long dc_wake_sequence;
	263	unsigned long dc_work_sequence;
ccd979bd	264
7ec373cf MF	265	/*
	266	* Any thread can add locks to the list, but the downconvert
	267	* thread is the only one allowed to remove locks. Any change
	268	* to this rule requires updating
	269	* ocfs2_downconvert_thread_do_work().
	270	*/
ccd979bd MF	271	struct list_head blocked_lock_list;
	272	unsigned long blocked_lock_count;
	273
ccd979bd MF	274	wait_queue_head_t osb_mount_event;
	275
	276	/* Truncate log info */
	277	struct inode *osb_tl_inode;
	278	struct buffer_head *osb_tl_bh;
c4028958	279	struct delayed_work osb_truncate_log_wq;
b4df6ed8 MF	280
	281	struct ocfs2_node_map osb_recovering_orphan_dirs;
	282	unsigned int *osb_orphan_wipes;
	283	wait_queue_head_t osb_wipe_event;
ccd979bd MF	284	};
	285
	286	#define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
ccd979bd MF	287
	288	static inline int ocfs2_should_order_data(struct inode *inode)
	289	{
	290	if (!S_ISREG(inode->i_mode))
	291	return 0;
	292	if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
	293	return 0;
	294	return 1;
	295	}
	296
dcd0538f MF	297	static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
	298	{
	299	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
	300	return 1;
	301	return 0;
	302	}
	303
328d5752 MF	304	static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
	305	{
	306	/*
	307	* Support for sparse files is a pre-requisite
	308	*/
	309	if (!ocfs2_sparse_alloc(osb))
	310	return 0;
	311
	312	if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
	313	return 1;
	314	return 0;
	315	}
	316
15b1e36b MF	317	static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
	318	{
	319	if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
	320	return 1;
	321	return 0;
	322	}
	323
ccd979bd MF	324	/* set / clear functions because cluster events can make these happen
	325	* in parallel so we want the transitions to be atomic. this also
	326	* means that any future flags osb_flags must be protected by spinlock
	327	* too! */
	328	static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
	329	unsigned long flag)
	330	{
	331	spin_lock(&osb->osb_lock);
	332	osb->osb_flags \|= flag;
	333	spin_unlock(&osb->osb_lock);
	334	}
	335
	336	static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
	337	int hard)
	338	{
	339	spin_lock(&osb->osb_lock);
	340	osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO\|OCFS2_OSB_HARD_RO);
	341	if (hard)
	342	osb->osb_flags \|= OCFS2_OSB_HARD_RO;
	343	else
	344	osb->osb_flags \|= OCFS2_OSB_SOFT_RO;
	345	spin_unlock(&osb->osb_lock);
	346	}
	347
	348	static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
	349	{
	350	int ret;
	351
	352	spin_lock(&osb->osb_lock);
	353	ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
	354	spin_unlock(&osb->osb_lock);
	355
	356	return ret;
	357	}
	358
	359	static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
	360	{
	361	int ret;
	362
	363	spin_lock(&osb->osb_lock);
	364	ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
	365	spin_unlock(&osb->osb_lock);
	366
	367	return ret;
	368	}
	369
c271c5c2 SM	370	static inline int ocfs2_mount_local(struct ocfs2_super *osb)
	371	{
	372	return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
	373	}
	374
ccd979bd MF	375	#define OCFS2_IS_VALID_DINODE(ptr) \
	376	(!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
	377
	378	#define OCFS2_RO_ON_INVALID_DINODE(__sb, __di) do { \
	379	typeof(__di) ____di = (__di); \
	380	ocfs2_error((__sb), \
b0697053	381	"Dinode # %llu has bad signature %.*s", \
1ca1a111	382	(unsigned long long)le64_to_cpu((____di)->i_blkno), 7, \
ccd979bd	383	(____di)->i_signature); \
1ca1a111	384	} while (0)
ccd979bd MF	385
	386	#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
	387	(!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
	388
	389	#define OCFS2_RO_ON_INVALID_EXTENT_BLOCK(__sb, __eb) do { \
	390	typeof(__eb) ____eb = (__eb); \
	391	ocfs2_error((__sb), \
b0697053	392	"Extent Block # %llu has bad signature %.*s", \
1ca1a111	393	(unsigned long long)le64_to_cpu((____eb)->h_blkno), 7, \
ccd979bd	394	(____eb)->h_signature); \
1ca1a111	395	} while (0)
ccd979bd MF	396
	397	#define OCFS2_IS_VALID_GROUP_DESC(ptr) \
	398	(!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
	399
	400	#define OCFS2_RO_ON_INVALID_GROUP_DESC(__sb, __gd) do { \
	401	typeof(__gd) ____gd = (__gd); \
	402	ocfs2_error((__sb), \
b0697053	403	"Group Descriptor # %llu has bad signature %.*s", \
1ca1a111	404	(unsigned long long)le64_to_cpu((____gd)->bg_blkno), 7, \
ccd979bd	405	(____gd)->bg_signature); \
1ca1a111	406	} while (0)
ccd979bd MF	407
	408	static inline unsigned long ino_from_blkno(struct super_block *sb,
	409	u64 blkno)
	410	{
	411	return (unsigned long)(blkno & (u64)ULONG_MAX);
	412	}
	413
	414	static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
	415	u32 clusters)
	416	{
	417	int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
	418	sb->s_blocksize_bits;
	419
	420	return (u64)clusters << c_to_b_bits;
	421	}
	422
	423	static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
	424	u64 blocks)
	425	{
	426	int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
	427	sb->s_blocksize_bits;
	428
	429	return (u32)(blocks >> b_to_c_bits);
	430	}
	431
	432	static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
	433	u64 bytes)
	434	{
	435	int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
	436	unsigned int clusters;
	437
	438	bytes += OCFS2_SB(sb)->s_clustersize - 1;
	439	/* OCFS2 just cannot have enough clusters to overflow this */
	440	clusters = (unsigned int)(bytes >> cl_bits);
	441
	442	return clusters;
	443	}
	444
	445	static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
	446	u64 bytes)
	447	{
	448	bytes += sb->s_blocksize - 1;
	449	return bytes >> sb->s_blocksize_bits;
	450	}
	451
	452	static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
	453	u32 clusters)
	454	{
	455	return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
	456	}
	457
	458	static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
	459	u64 bytes)
	460	{
	461	int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
	462	unsigned int clusters;
	463
	464	clusters = ocfs2_clusters_for_bytes(sb, bytes);
	465	return (u64)clusters << cl_bits;
	466	}
	467
	468	static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
	469	u64 bytes)
	470	{
471	u64 blocks;
472
473	blocks = ocfs2_blocks_for_bytes(sb, bytes);
474	return blocks << sb->s_blocksize_bits;
475	}
476
477	static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
478	{
479	return (unsigned long)((bytes + 511) >> 9);
480	}
481
9517bac6 MF	482	static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
	483	unsigned long pg_index)
	484	{
	485	u32 clusters = pg_index;
	486	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
	487
	488	if (unlikely(PAGE_CACHE_SHIFT > cbits))
	489	clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
	490	else if (PAGE_CACHE_SHIFT < cbits)
	491	clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
	492
	493	return clusters;
	494	}
	495
	496	/*
	497	* Find the 1st page index which covers the given clusters.
	498	*/
7c08d70c	499	static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
9517bac6 MF	500	u32 clusters)
	501	{
	502	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
7c08d70c	503	pgoff_t index = clusters;
9517bac6 MF	504
9517bac6 MF	505	if (PAGE_CACHE_SHIFT > cbits) {
7c08d70c	506	index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
9517bac6	507	} else if (PAGE_CACHE_SHIFT < cbits) {
7c08d70c	508	index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
9517bac6 MF	509	}
	510
	511	return index;
	512	}
	513
60b11392 MF	514	static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
	515	{
	516	unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
	517	unsigned int pages_per_cluster = 1;
	518
	519	if (PAGE_CACHE_SHIFT < cbits)
	520	pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
	521
	522	return pages_per_cluster;
	523	}
	524
ccd979bd MF	525	#define ocfs2_set_bit ext2_set_bit
	526	#define ocfs2_clear_bit ext2_clear_bit
	527	#define ocfs2_test_bit ext2_test_bit
	528	#define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
	529	#endif /* OCFS2_H */
	530