[linux-block.git] / fs / nilfs2 / mdt.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * NILFS meta data file prototype and definitions
 *
 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
 *
 * 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
 * @inode: holder of page caches used in shadow mapping
 * @frozen_buffers: list of frozen buffers
 */
struct nilfs_shadow_map {
	struct nilfs_bmap_store bmap_store;
	struct inode *inode;
	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
ae98043f	1	/* SPDX-License-Identifier: GPL-2.0+ */
5eb563f5	2	/*
94ee1d91	3	* NILFS meta data file prototype and definitions
5eb563f5 RK	4	*
	5	* Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
	6	*
4b420ab4	7	* Written by Ryusuke Konishi.
5eb563f5 RK	8	*/
	9
	10	#ifndef _NILFS_MDT_H
	11	#define _NILFS_MDT_H
	12
	13	#include <linux/buffer_head.h>
	14	#include <linux/blockgroup_lock.h>
	15	#include "nilfs.h"
	16	#include "page.h"
	17
f5974c8f VD	18	/**
	19	* struct nilfs_shadow_map - shadow mapping of meta data file
	20	* @bmap_store: shadow copy of bmap state
6e211930	21	* @inode: holder of page caches used in shadow mapping
f5974c8f VD	22	* @frozen_buffers: list of frozen buffers
f5974c8f VD	23	*/
ebdfed4d RK	24	struct nilfs_shadow_map {
ebdfed4d RK	25	struct nilfs_bmap_store bmap_store;
6e211930	26	struct inode *inode;
ebdfed4d RK	27	struct list_head frozen_buffers;
	28	};
	29
5eb563f5 RK	30	/**
5eb563f5 RK	31	* struct nilfs_mdt_info - on-memory private data of meta data files
5eb563f5 RK	32	* @mi_sem: reader/writer semaphore for meta data operations
	33	* @mi_bgl: per-blockgroup locking
	34	* @mi_entry_size: size of an entry
	35	* @mi_first_entry_offset: offset to the first entry
	36	* @mi_entries_per_block: number of entries in a block
db38d5ad	37	* @mi_palloc_cache: persistent object allocator cache
ebdfed4d	38	* @mi_shadow: shadow of bmap and page caches
5eb563f5 RK	39	* @mi_blocks_per_group: number of blocks in a group
	40	* @mi_blocks_per_desc_block: number of blocks per descriptor block
	41	*/
	42	struct nilfs_mdt_info {
5eb563f5 RK	43	struct rw_semaphore mi_sem;
5eb563f5 RK	44	struct blockgroup_lock *mi_bgl;
0c6c44cb RK	45	unsigned int mi_entry_size;
0c6c44cb RK	46	unsigned int mi_first_entry_offset;
5eb563f5	47	unsigned long mi_entries_per_block;
db38d5ad	48	struct nilfs_palloc_cache *mi_palloc_cache;
ebdfed4d	49	struct nilfs_shadow_map *mi_shadow;
5eb563f5 RK	50	unsigned long mi_blocks_per_group;
	51	unsigned long mi_blocks_per_desc_block;
	52	};
	53
	54	static inline struct nilfs_mdt_info NILFS_MDT(const struct inode inode)
	55	{
	56	return inode->i_private;
	57	}
	58
2d19961d RK	59	static inline int nilfs_is_metadata_file_inode(const struct inode *inode)
	60	{
	61	return inode->i_private != NULL;
	62	}
	63
5eb563f5	64	/* Default GFP flags using highmem */
71baba4b	65	#define NILFS_MDT_GFP (__GFP_RECLAIM \| __GFP_IO \| __GFP_HIGHMEM)
5eb563f5 RK	66
	67	int nilfs_mdt_get_block(struct inode *, unsigned long, int,
	68	void (init_block)(struct inode ,
	69	struct buffer_head , void ),
	70	struct buffer_head **);
fa33915c RK	71	int nilfs_mdt_find_block(struct inode *inode, unsigned long start,
	72	unsigned long end, unsigned long *blkoff,
	73	struct buffer_head **out_bh);
5eb563f5 RK	74	int nilfs_mdt_delete_block(struct inode *, unsigned long);
5eb563f5 RK	75	int nilfs_mdt_forget_block(struct inode *, unsigned long);
5eb563f5 RK	76	int nilfs_mdt_fetch_dirty(struct inode *);
5eb563f5 RK	77
f1e89c86	78	int nilfs_mdt_init(struct inode *inode, gfp_t gfp_mask, size_t objsz);
2d19961d RK	79	void nilfs_mdt_clear(struct inode *inode);
	80	void nilfs_mdt_destroy(struct inode *inode);
	81
0c6c44cb	82	void nilfs_mdt_set_entry_size(struct inode *, unsigned int, unsigned int);
5eb563f5	83
ebdfed4d RK	84	int nilfs_mdt_setup_shadow_map(struct inode *inode,
	85	struct nilfs_shadow_map *shadow);
	86	int nilfs_mdt_save_to_shadow_map(struct inode *inode);
	87	void nilfs_mdt_restore_from_shadow_map(struct inode *inode);
	88	void nilfs_mdt_clear_shadow_map(struct inode *inode);
b1f6a4f2 RK	89	int nilfs_mdt_freeze_buffer(struct inode inode, struct buffer_head bh);
	90	struct buffer_head nilfs_mdt_get_frozen_buffer(struct inode inode,
	91	struct buffer_head *bh);
5eb563f5	92
5eb563f5 RK	93	static inline void nilfs_mdt_mark_dirty(struct inode *inode)
	94	{
	95	if (!test_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state))
	96	set_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state);
	97	}
	98
	99	static inline void nilfs_mdt_clear_dirty(struct inode *inode)
	100	{
	101	clear_bit(NILFS_I_DIRTY, &NILFS_I(inode)->i_state);
	102	}
	103
	104	static inline __u64 nilfs_mdt_cno(struct inode *inode)
	105	{
0ef28f9a	106	return ((struct the_nilfs *)inode->i_sb->s_fs_info)->ns_cno;
5eb563f5 RK	107	}
5eb563f5 RK	108
0de6d6b9 RK	109	static inline spinlock_t *
	110	nilfs_mdt_bgl_lock(struct inode *inode, unsigned int block_group)
	111	{
	112	return bgl_lock_ptr(NILFS_MDT(inode)->mi_bgl, block_group);
	113	}
5eb563f5	114
5eb563f5	115	#endif /* _NILFS_MDT_H */