[deliverable/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>

/* For union ocfs2_dlm_lksb */
#include "stackglue.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;
	union ocfs2_dlm_lksb     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_slot_info;
struct ocfs2_recovery_map;
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;

	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;

	unsigned int max_slots;
	unsigned int node_num;
	int slot_num;
	int preferred_slot;
	int s_sectsize_bits;
	int s_clustersize;
	int s_clustersize_bits;

	atomic_t vol_state;
	struct mutex recovery_lock;
	struct ocfs2_recovery_map *recovery_map;
	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 ocfs2_cluster_connection *cconn;
	struct ocfs2_lock_res osb_super_lockres;
	struct ocfs2_lock_res osb_rename_lockres;
	struct ocfs2_dlm_debug *osb_dlm_debug;

	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);
}

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


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