[deliverable/linux.git] / fs / xfs / xfs_iomap.h

/*
 * Copyright (c) 2003-2005 Silicon Graphics, Inc.
 * 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.
 *
 * This program is distributed in the hope that it would 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 the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef __XFS_IOMAP_H__
#define __XFS_IOMAP_H__

#define IOMAP_DADDR_NULL ((xfs_daddr_t) (-1LL))


typedef enum {				/* iomap_flags values */
	IOMAP_READ =		0,	/* mapping for a read */
	IOMAP_EOF =		0x01,	/* mapping contains EOF   */
	IOMAP_HOLE =		0x02,	/* mapping covers a hole  */
	IOMAP_DELAY =		0x04,	/* mapping covers delalloc region  */
	IOMAP_REALTIME =	0x10,	/* mapping on the realtime device  */
	IOMAP_UNWRITTEN =	0x20,	/* mapping covers allocated */
					/* but uninitialized file data  */
	IOMAP_NEW =		0x40	/* just allocate */
} iomap_flags_t;

typedef enum {
	/* base extent manipulation calls */
	BMAPI_READ = (1 << 0),		/* read extents */
	BMAPI_WRITE = (1 << 1),		/* create extents */
	BMAPI_ALLOCATE = (1 << 2),	/* delayed allocate to real extents */
	BMAPI_UNWRITTEN  = (1 << 3),	/* unwritten extents to real extents */
	/* modifiers */
	BMAPI_IGNSTATE = (1 << 4),	/* ignore unwritten state on read */
	BMAPI_DIRECT = (1 << 5),	/* direct instead of buffered write */
	BMAPI_MMAP = (1 << 6),		/* allocate for mmap write */
	BMAPI_SYNC = (1 << 7),		/* sync write to flush delalloc space */
	BMAPI_TRYLOCK = (1 << 8),	/* non-blocking request */
	BMAPI_DEVICE = (1 << 9),	/* we only want to know the device */
} bmapi_flags_t;


/*
 * xfs_iomap_t:  File system I/O map
 *
 * The iomap_bn field is expressed in 512-byte blocks, and is where the
 * mapping starts on disk.
 *
 * The iomap_offset, iomap_bsize and iomap_delta fields are in bytes.
 * iomap_offset is the offset of the mapping in the file itself.
 * iomap_bsize is the size of the mapping,  iomap_delta is the
 * desired data's offset into the mapping, given the offset supplied
 * to the file I/O map routine.
 *
 * When a request is made to read beyond the logical end of the object,
 * iomap_size may be set to 0, but iomap_offset and iomap_length should be set
 * to the actual amount of underlying storage that has been allocated, if any.
 */

typedef struct xfs_iomap {
	xfs_daddr_t		iomap_bn;	/* first 512b blk of mapping */
	xfs_buftarg_t		*iomap_target;
	xfs_off_t		iomap_offset;	/* offset of mapping, bytes */
	xfs_off_t		iomap_bsize;	/* size of mapping, bytes */
	xfs_off_t		iomap_delta;	/* offset into mapping, bytes */
	iomap_flags_t		iomap_flags;
} xfs_iomap_t;

struct xfs_iocore;
struct xfs_inode;
struct xfs_bmbt_irec;

extern int xfs_iomap(struct xfs_iocore *, xfs_off_t, ssize_t, int,
		     struct xfs_iomap *, int *);
extern int xfs_iomap_write_direct(struct xfs_inode *, xfs_off_t, size_t,
				  int, struct xfs_bmbt_irec *, int *, int);
extern int xfs_iomap_write_delay(struct xfs_inode *, xfs_off_t, size_t, int,
				 struct xfs_bmbt_irec *, int *);
extern int xfs_iomap_write_allocate(struct xfs_inode *, xfs_off_t, size_t,
				struct xfs_bmbt_irec *, int *);
extern int xfs_iomap_write_unwritten(struct xfs_inode *, xfs_off_t, size_t);

#endif /* __XFS_IOMAP_H__*/
Commit	Line	Data
1da177e4	1	/*
7b718769 NS	2	* Copyright (c) 2003-2005 Silicon Graphics, Inc.
7b718769 NS	3	* All Rights Reserved.
1da177e4	4	*
7b718769 NS	5	* This program is free software; you can redistribute it and/or
7b718769 NS	6	* modify it under the terms of the GNU General Public License as
1da177e4 LT	7	* published by the Free Software Foundation.
1da177e4 LT	8	*
7b718769 NS	9	* This program is distributed in the hope that it would be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
1da177e4	13	*
7b718769 NS	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write the Free Software Foundation,
	16	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
1da177e4	17	*/
1da177e4 LT	18	#ifndef __XFS_IOMAP_H__
	19	#define __XFS_IOMAP_H__
	20
	21	#define IOMAP_DADDR_NULL ((xfs_daddr_t) (-1LL))
	22
	23
	24	typedef enum { /* iomap_flags values */
ba87ea69	25	IOMAP_READ = 0, /* mapping for a read */
1da177e4 LT	26	IOMAP_EOF = 0x01, /* mapping contains EOF */
	27	IOMAP_HOLE = 0x02, /* mapping covers a hole */
	28	IOMAP_DELAY = 0x04, /* mapping covers delalloc region */
	29	IOMAP_REALTIME = 0x10, /* mapping on the realtime device */
	30	IOMAP_UNWRITTEN = 0x20, /* mapping covers allocated */
	31	/* but uninitialized file data */
	32	IOMAP_NEW = 0x40 /* just allocate */
	33	} iomap_flags_t;
	34
	35	typedef enum {
	36	/* base extent manipulation calls */
	37	BMAPI_READ = (1 << 0), /* read extents */
	38	BMAPI_WRITE = (1 << 1), /* create extents */
	39	BMAPI_ALLOCATE = (1 << 2), /* delayed allocate to real extents */
	40	BMAPI_UNWRITTEN = (1 << 3), /* unwritten extents to real extents */
	41	/* modifiers */
	42	BMAPI_IGNSTATE = (1 << 4), /* ignore unwritten state on read */
24e17b5f	43	BMAPI_DIRECT = (1 << 5), /* direct instead of buffered write */
1da177e4 LT	44	BMAPI_MMAP = (1 << 6), /* allocate for mmap write */
	45	BMAPI_SYNC = (1 << 7), /* sync write to flush delalloc space */
	46	BMAPI_TRYLOCK = (1 << 8), /* non-blocking request */
	47	BMAPI_DEVICE = (1 << 9), /* we only want to know the device */
	48	} bmapi_flags_t;
	49
	50
	51	/*
	52	* xfs_iomap_t: File system I/O map
	53	*
f403b7f4	54	* The iomap_bn field is expressed in 512-byte blocks, and is where the
1da177e4 LT	55	* mapping starts on disk.
	56	*
	57	* The iomap_offset, iomap_bsize and iomap_delta fields are in bytes.
	58	* iomap_offset is the offset of the mapping in the file itself.
f403b7f4 NS	59	* iomap_bsize is the size of the mapping, iomap_delta is the
f403b7f4 NS	60	* desired data's offset into the mapping, given the offset supplied
1da177e4 LT	61	* to the file I/O map routine.
	62	*
	63	* When a request is made to read beyond the logical end of the object,
	64	* iomap_size may be set to 0, but iomap_offset and iomap_length should be set
	65	* to the actual amount of underlying storage that has been allocated, if any.
	66	*/
	67
	68	typedef struct xfs_iomap {
	69	xfs_daddr_t iomap_bn; /* first 512b blk of mapping */
	70	xfs_buftarg_t *iomap_target;
f403b7f4 NS	71	xfs_off_t iomap_offset; /* offset of mapping, bytes */
f403b7f4 NS	72	xfs_off_t iomap_bsize; /* size of mapping, bytes */
55b02d74	73	xfs_off_t iomap_delta; /* offset into mapping, bytes */
1da177e4 LT	74	iomap_flags_t iomap_flags;
	75	} xfs_iomap_t;
	76
	77	struct xfs_iocore;
	78	struct xfs_inode;
	79	struct xfs_bmbt_irec;
	80
	81	extern int xfs_iomap(struct xfs_iocore *, xfs_off_t, ssize_t, int,
	82	struct xfs_iomap , int );
f403b7f4	83	extern int xfs_iomap_write_direct(struct xfs_inode *, xfs_off_t, size_t,
1da177e4	84	int, struct xfs_bmbt_irec , int , int);
f403b7f4	85	extern int xfs_iomap_write_delay(struct xfs_inode *, xfs_off_t, size_t, int,
1da177e4	86	struct xfs_bmbt_irec , int );
f403b7f4	87	extern int xfs_iomap_write_allocate(struct xfs_inode *, xfs_off_t, size_t,
1da177e4	88	struct xfs_bmbt_irec , int );
f403b7f4	89	extern int xfs_iomap_write_unwritten(struct xfs_inode *, xfs_off_t, size_t);
1da177e4 LT	90
1da177e4 LT	91	#endif /* __XFS_IOMAP_H__*/