[mirror_ubuntu-zesty-kernel.git] / fs / nilfs2 / mdt.h

/*
 * mdt.h - NILFS meta data file prototype and definitions
 *
 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
 *
 * 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.
 *
 * Written by Ryusuke Konishi.
 */

#ifndef _NILFS_MDT_H
#define _NILFS_MDT_H

#include <linux/buffer_head.h>
#include <linux/blockgroup_lock.h>
#include "nilfs.h"
#include "page.h"

/**
 * struct nilfs_shadow_map - shadow mapping of meta data file
 * @bmap_store: shadow copy of bmap state
 * @frozen_data: shadowed dirty data pages
 * @frozen_btnodes: shadowed dirty b-tree nodes' pages
 * @frozen_buffers: list of frozen buffers
 */
struct nilfs_shadow_map {
	struct nilfs_bmap_store bmap_store;
	struct address_space frozen_data;
	struct address_space frozen_btnodes;
	struct list_head frozen_buffers;
};

/**
 * struct nilfs_mdt_info - on-memory private data of meta data files
 * @mi_sem: reader/writer semaphore for meta data operations
 * @mi_bgl: per-blockgroup locking
 * @mi_entry_size: size of an entry
 * @mi_first_entry_offset: offset to the first entry
 * @mi_entries_per_block: number of entries in a block
 * @mi_palloc_cache: persistent object allocator cache
 * @mi_shadow: shadow of bmap and page caches
 * @mi_blocks_per_group: number of blocks in a group
 * @mi_blocks_per_desc_block: number of blocks per descriptor block
 */
struct nilfs_mdt_info {
	struct rw_semaphore	mi_sem;
	struct blockgroup_lock *mi_bgl;
	unsigned int		mi_entry_size;
	unsigned int		mi_first_entry_offset;
	unsigned long		mi_entries_per_block;
	struct nilfs_palloc_cache *mi_palloc_cache;
	struct nilfs_shadow_map *mi_shadow;
	unsigned long		mi_blocks_per_group;
	unsigned long		mi_blocks_per_desc_block;
};

static inline struct nilfs_mdt_info *NILFS_MDT(const struct inode *inode)
{
	return inode->i_private;
}

static inline int nilfs_is_metadata_file_inode(const struct inode *inode)
{
	return inode->i_private != NULL;
}

/* Default GFP flags using highmem */
#define NILFS_MDT_GFP      (__GFP_RECLAIM | __GFP_IO | __GFP_HIGHMEM)

int nilfs_mdt_get_block(struct inode *, unsigned long, int,
			void (*init_block)(struct inode *,
					   struct buffer_head *, void *),
			struct buffer_head **);
int nilfs_mdt_find_block(struct inode *inode, unsigned long start,
			 unsigned long end, unsigned long *blkoff,
			 struct buffer_head **out_bh);
int nilfs_mdt_delete_block(struct inode *, unsigned long);
int nilfs_mdt_forget_block(struct inode *, unsigned long);
int nilfs_mdt_fetch_dirty(struct inode *);

int nilfs_mdt_init(struct inode *inode, gfp_t gfp_mask, size_t objsz);
void nilfs_mdt_clear(struct inode *inode);
void nilfs_mdt_destroy(struct inode *inode);

void nilfs_mdt_set_entry_size(struct inode *, unsigned int, unsigned int);

int nilfs_mdt_setup_shadow_map(struct inode *inode,
			       struct nilfs_shadow_map *shadow);
int nilfs_mdt_save_to_shadow_map(struct inode *inode);
void nilfs_mdt_restore_from_shadow_map(struct inode *inode);
void nilfs_mdt_clear_shadow_map(struct inode *inode);
int nilfs_mdt_freeze_buffer(struct inode *inode, struct buffer_head *bh);
struct buffer_head *nilfs_mdt_get_frozen_buffer(struct inode *inode,
						struct buffer_head *bh);

static inline void nilfs_mdt_mark_dirty(struct inode *inode)
{
	if (!test_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state))
		set_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state);
}

static inline void nilfs_mdt_clear_dirty(struct inode *inode)
{
	clear_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state);
}

static inline __u64 nilfs_mdt_cno(struct inode *inode)
{
	return ((struct the_nilfs *)inode->i_sb->s_fs_info)->ns_cno;
}

static inline spinlock_t *
nilfs_mdt_bgl_lock(struct inode *inode, unsigned int block_group)
{
	return bgl_lock_ptr(NILFS_MDT(inode)->mi_bgl, block_group);
}

#endif /* _NILFS_MDT_H */
Commit	Line	Data
5eb563f5 RK	1	/*
	2	* mdt.h - NILFS meta data file prototype and definitions
	3	*
	4	* Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
4b420ab4	16	* Written by Ryusuke Konishi.
5eb563f5 RK	17	*/
	18
	19	#ifndef _NILFS_MDT_H
	20	#define _NILFS_MDT_H
	21
	22	#include <linux/buffer_head.h>
	23	#include <linux/blockgroup_lock.h>
	24	#include "nilfs.h"
	25	#include "page.h"
	26
f5974c8f VD	27	/**
	28	* struct nilfs_shadow_map - shadow mapping of meta data file
	29	* @bmap_store: shadow copy of bmap state
	30	* @frozen_data: shadowed dirty data pages
	31	* @frozen_btnodes: shadowed dirty b-tree nodes' pages
	32	* @frozen_buffers: list of frozen buffers
	33	*/
ebdfed4d RK	34	struct nilfs_shadow_map {
	35	struct nilfs_bmap_store bmap_store;
	36	struct address_space frozen_data;
	37	struct address_space frozen_btnodes;
	38	struct list_head frozen_buffers;
	39	};
	40
5eb563f5 RK	41	/**
5eb563f5 RK	42	* struct nilfs_mdt_info - on-memory private data of meta data files
5eb563f5 RK	43	* @mi_sem: reader/writer semaphore for meta data operations
	44	* @mi_bgl: per-blockgroup locking
	45	* @mi_entry_size: size of an entry
	46	* @mi_first_entry_offset: offset to the first entry
	47	* @mi_entries_per_block: number of entries in a block
db38d5ad	48	* @mi_palloc_cache: persistent object allocator cache
ebdfed4d	49	* @mi_shadow: shadow of bmap and page caches
5eb563f5 RK	50	* @mi_blocks_per_group: number of blocks in a group
	51	* @mi_blocks_per_desc_block: number of blocks per descriptor block
	52	*/
	53	struct nilfs_mdt_info {
5eb563f5 RK	54	struct rw_semaphore mi_sem;
5eb563f5 RK	55	struct blockgroup_lock *mi_bgl;
0c6c44cb RK	56	unsigned int mi_entry_size;
0c6c44cb RK	57	unsigned int mi_first_entry_offset;
5eb563f5	58	unsigned long mi_entries_per_block;
db38d5ad	59	struct nilfs_palloc_cache *mi_palloc_cache;
ebdfed4d	60	struct nilfs_shadow_map *mi_shadow;
5eb563f5 RK	61	unsigned long mi_blocks_per_group;
	62	unsigned long mi_blocks_per_desc_block;
	63	};
	64
	65	static inline struct nilfs_mdt_info NILFS_MDT(const struct inode inode)
	66	{
	67	return inode->i_private;
	68	}
	69
2d19961d RK	70	static inline int nilfs_is_metadata_file_inode(const struct inode *inode)
	71	{
	72	return inode->i_private != NULL;
	73	}
	74
5eb563f5	75	/* Default GFP flags using highmem */
71baba4b	76	#define NILFS_MDT_GFP (__GFP_RECLAIM \| __GFP_IO \| __GFP_HIGHMEM)
5eb563f5 RK	77
	78	int nilfs_mdt_get_block(struct inode *, unsigned long, int,
	79	void (init_block)(struct inode ,
	80	struct buffer_head , void ),
	81	struct buffer_head **);
fa33915c RK	82	int nilfs_mdt_find_block(struct inode *inode, unsigned long start,
	83	unsigned long end, unsigned long *blkoff,
	84	struct buffer_head **out_bh);
5eb563f5 RK	85	int nilfs_mdt_delete_block(struct inode *, unsigned long);
5eb563f5 RK	86	int nilfs_mdt_forget_block(struct inode *, unsigned long);
5eb563f5 RK	87	int nilfs_mdt_fetch_dirty(struct inode *);
5eb563f5 RK	88
f1e89c86	89	int nilfs_mdt_init(struct inode *inode, gfp_t gfp_mask, size_t objsz);
2d19961d RK	90	void nilfs_mdt_clear(struct inode *inode);
	91	void nilfs_mdt_destroy(struct inode *inode);
	92
0c6c44cb	93	void nilfs_mdt_set_entry_size(struct inode *, unsigned int, unsigned int);
5eb563f5	94
ebdfed4d RK	95	int nilfs_mdt_setup_shadow_map(struct inode *inode,
	96	struct nilfs_shadow_map *shadow);
	97	int nilfs_mdt_save_to_shadow_map(struct inode *inode);
	98	void nilfs_mdt_restore_from_shadow_map(struct inode *inode);
	99	void nilfs_mdt_clear_shadow_map(struct inode *inode);
b1f6a4f2 RK	100	int nilfs_mdt_freeze_buffer(struct inode inode, struct buffer_head bh);
	101	struct buffer_head nilfs_mdt_get_frozen_buffer(struct inode inode,
	102	struct buffer_head *bh);
5eb563f5	103
5eb563f5 RK	104	static inline void nilfs_mdt_mark_dirty(struct inode *inode)
	105	{
	106	if (!test_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state))
	107	set_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state);
	108	}
	109
	110	static inline void nilfs_mdt_clear_dirty(struct inode *inode)
	111	{
	112	clear_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state);
	113	}
	114
	115	static inline __u64 nilfs_mdt_cno(struct inode *inode)
	116	{
0ef28f9a	117	return ((struct the_nilfs *)inode->i_sb->s_fs_info)->ns_cno;
5eb563f5 RK	118	}
5eb563f5 RK	119
0de6d6b9 RK	120	static inline spinlock_t *
	121	nilfs_mdt_bgl_lock(struct inode *inode, unsigned int block_group)
	122	{
	123	return bgl_lock_ptr(NILFS_MDT(inode)->mi_bgl, block_group);
	124	}
5eb563f5	125
5eb563f5	126	#endif /* _NILFS_MDT_H */