[linux.git] / fs / nilfs2 / sufile.h

/*
 * sufile.h - NILFS segment usage file.
 *
 * Copyright (C) 2006-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.
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Written by Koji Sato <[email protected]>.
 */

#ifndef _NILFS_SUFILE_H
#define _NILFS_SUFILE_H

#include <linux/fs.h>
#include <linux/buffer_head.h>
#include <linux/nilfs2_fs.h>
#include "mdt.h"

#define NILFS_SUFILE_GFP	NILFS_MDT_GFP

static inline unsigned long nilfs_sufile_get_nsegments(struct inode *sufile)
{
	return NILFS_MDT(sufile)->mi_nilfs->ns_nsegments;
}

int nilfs_sufile_alloc(struct inode *, __u64 *);
int nilfs_sufile_get_segment_usage(struct inode *, __u64,
				   struct nilfs_segment_usage **,
				   struct buffer_head **);
void nilfs_sufile_put_segment_usage(struct inode *, __u64,
				    struct buffer_head *);
int nilfs_sufile_get_stat(struct inode *, struct nilfs_sustat *);
int nilfs_sufile_get_ncleansegs(struct inode *, unsigned long *);
ssize_t nilfs_sufile_get_suinfo(struct inode *, __u64, struct nilfs_suinfo *,
				size_t);

int nilfs_sufile_updatev(struct inode *, __u64 *, size_t, int, size_t *,
			 void (*dofunc)(struct inode *, __u64,
					struct buffer_head *,
					struct buffer_head *));
int nilfs_sufile_update(struct inode *, __u64, int,
			void (*dofunc)(struct inode *, __u64,
				       struct buffer_head *,
				       struct buffer_head *));
void nilfs_sufile_do_scrap(struct inode *, __u64, struct buffer_head *,
			   struct buffer_head *);
void nilfs_sufile_do_free(struct inode *, __u64, struct buffer_head *,
			  struct buffer_head *);
void nilfs_sufile_do_cancel_free(struct inode *, __u64, struct buffer_head *,
				 struct buffer_head *);
void nilfs_sufile_do_set_error(struct inode *, __u64, struct buffer_head *,
			       struct buffer_head *);

/**
 * nilfs_sufile_scrap - make a segment garbage
 * @sufile: inode of segment usage file
 * @segnum: segment number to be freed
 */
static inline int nilfs_sufile_scrap(struct inode *sufile, __u64 segnum)
{
	return nilfs_sufile_update(sufile, segnum, 1, nilfs_sufile_do_scrap);
}

/**
 * nilfs_sufile_free - free segment
 * @sufile: inode of segment usage file
 * @segnum: segment number to be freed
 */
static inline int nilfs_sufile_free(struct inode *sufile, __u64 segnum)
{
	return nilfs_sufile_update(sufile, segnum, 0, nilfs_sufile_do_free);
}

/**
 * nilfs_sufile_freev - free segments
 * @sufile: inode of segment usage file
 * @segnumv: array of segment numbers
 * @nsegs: size of @segnumv array
 * @ndone: place to store the number of freed segments
 */
static inline int nilfs_sufile_freev(struct inode *sufile, __u64 *segnumv,
				     size_t nsegs, size_t *ndone)
{
	return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
				    nilfs_sufile_do_free);
}

/**
 * nilfs_sufile_cancel_freev - reallocate freeing segments
 * @sufile: inode of segment usage file
 * @segnumv: array of segment numbers
 * @nsegs: size of @segnumv array
 * @ndone: place to store the number of cancelled segments
 *
 * Return Value: On success, 0 is returned. On error, a negative error codes
 * is returned.
 */
static inline int nilfs_sufile_cancel_freev(struct inode *sufile,
					    __u64 *segnumv, size_t nsegs,
					    size_t *ndone)
{
	return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
				    nilfs_sufile_do_cancel_free);
}

/**
 * nilfs_sufile_set_error - mark a segment as erroneous
 * @sufile: inode of segment usage file
 * @segnum: segment number
 *
 * Description: nilfs_sufile_set_error() marks the segment specified by
 * @segnum as erroneous. The error segment will never be used again.
 *
 * Return Value: On success, 0 is returned. On error, one of the following
 * negative error codes is returned.
 *
 * %-EIO - I/O error.
 *
 * %-ENOMEM - Insufficient amount of memory available.
 *
 * %-EINVAL - Invalid segment usage number.
 */
static inline int nilfs_sufile_set_error(struct inode *sufile, __u64 segnum)
{
	return nilfs_sufile_update(sufile, segnum, 0,
				   nilfs_sufile_do_set_error);
}

#endif	/* _NILFS_SUFILE_H */
Commit	Line	Data
6c98cd4e KS	1	/*
	2	* sufile.h - NILFS segment usage file.
	3	*
	4	* Copyright (C) 2006-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	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*
	20	* Written by Koji Sato <[email protected]>.
	21	*/
	22
	23	#ifndef _NILFS_SUFILE_H
	24	#define _NILFS_SUFILE_H
	25
	26	#include <linux/fs.h>
	27	#include <linux/buffer_head.h>
	28	#include <linux/nilfs2_fs.h>
	29	#include "mdt.h"
	30
	31	#define NILFS_SUFILE_GFP NILFS_MDT_GFP
	32
	33	static inline unsigned long nilfs_sufile_get_nsegments(struct inode *sufile)
	34	{
	35	return NILFS_MDT(sufile)->mi_nilfs->ns_nsegments;
	36	}
	37
	38	int nilfs_sufile_alloc(struct inode , __u64 );
6c98cd4e KS	39	int nilfs_sufile_get_segment_usage(struct inode *, __u64,
	40	struct nilfs_segment_usage **,
	41	struct buffer_head **);
	42	void nilfs_sufile_put_segment_usage(struct inode *, __u64,
	43	struct buffer_head *);
	44	int nilfs_sufile_get_stat(struct inode , struct nilfs_sustat );
	45	int nilfs_sufile_get_ncleansegs(struct inode , unsigned long );
6c98cd4e KS	46	ssize_t nilfs_sufile_get_suinfo(struct inode , __u64, struct nilfs_suinfo ,
	47	size_t);
	48
dda54f4b RK	49	int nilfs_sufile_updatev(struct inode , __u64 , size_t, int, size_t *,
	50	void (dofunc)(struct inode , __u64,
	51	struct buffer_head *,
	52	struct buffer_head *));
a703018f RK	53	int nilfs_sufile_update(struct inode *, __u64, int,
	54	void (dofunc)(struct inode , __u64,
	55	struct buffer_head *,
	56	struct buffer_head *));
c85399c2 RK	57	void nilfs_sufile_do_scrap(struct inode , __u64, struct buffer_head ,
c85399c2 RK	58	struct buffer_head *);
a703018f RK	59	void nilfs_sufile_do_free(struct inode , __u64, struct buffer_head ,
a703018f RK	60	struct buffer_head *);
071cb4b8 RK	61	void nilfs_sufile_do_cancel_free(struct inode , __u64, struct buffer_head ,
071cb4b8 RK	62	struct buffer_head *);
a703018f RK	63	void nilfs_sufile_do_set_error(struct inode , __u64, struct buffer_head ,
	64	struct buffer_head *);
	65
c85399c2 RK	66	/**
	67	* nilfs_sufile_scrap - make a segment garbage
	68	* @sufile: inode of segment usage file
	69	* @segnum: segment number to be freed
	70	*/
	71	static inline int nilfs_sufile_scrap(struct inode *sufile, __u64 segnum)
	72	{
	73	return nilfs_sufile_update(sufile, segnum, 1, nilfs_sufile_do_scrap);
	74	}
	75
a703018f RK	76	/**
	77	* nilfs_sufile_free - free segment
	78	* @sufile: inode of segment usage file
	79	* @segnum: segment number to be freed
	80	*/
	81	static inline int nilfs_sufile_free(struct inode *sufile, __u64 segnum)
	82	{
	83	return nilfs_sufile_update(sufile, segnum, 0, nilfs_sufile_do_free);
	84	}
	85
071cb4b8 RK	86	/**
	87	* nilfs_sufile_freev - free segments
	88	* @sufile: inode of segment usage file
	89	* @segnumv: array of segment numbers
	90	* @nsegs: size of @segnumv array
	91	* @ndone: place to store the number of freed segments
	92	*/
	93	static inline int nilfs_sufile_freev(struct inode sufile, __u64 segnumv,
	94	size_t nsegs, size_t *ndone)
	95	{
	96	return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
	97	nilfs_sufile_do_free);
	98	}
	99
	100	/**
	101	* nilfs_sufile_cancel_freev - reallocate freeing segments
	102	* @sufile: inode of segment usage file
	103	* @segnumv: array of segment numbers
	104	* @nsegs: size of @segnumv array
	105	* @ndone: place to store the number of cancelled segments
	106	*
	107	* Return Value: On success, 0 is returned. On error, a negative error codes
	108	* is returned.
	109	*/
	110	static inline int nilfs_sufile_cancel_freev(struct inode *sufile,
	111	__u64 *segnumv, size_t nsegs,
	112	size_t *ndone)
	113	{
	114	return nilfs_sufile_updatev(sufile, segnumv, nsegs, 0, ndone,
	115	nilfs_sufile_do_cancel_free);
	116	}
	117
a703018f RK	118	/**
	119	* nilfs_sufile_set_error - mark a segment as erroneous
	120	* @sufile: inode of segment usage file
	121	* @segnum: segment number
	122	*
	123	* Description: nilfs_sufile_set_error() marks the segment specified by
	124	* @segnum as erroneous. The error segment will never be used again.
	125	*
	126	* Return Value: On success, 0 is returned. On error, one of the following
	127	* negative error codes is returned.
	128	*
	129	* %-EIO - I/O error.
	130	*
	131	* %-ENOMEM - Insufficient amount of memory available.
	132	*
	133	* %-EINVAL - Invalid segment usage number.
	134	*/
	135	static inline int nilfs_sufile_set_error(struct inode *sufile, __u64 segnum)
	136	{
	137	return nilfs_sufile_update(sufile, segnum, 0,
	138	nilfs_sufile_do_set_error);
	139	}
6c98cd4e KS	140
6c98cd4e KS	141	#endif /* _NILFS_SUFILE_H */