blob: fcd6d63bb68ba4c4db7da17d15d8dfcb0572d8e4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2003-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#ifndef __XFS_IOMAP_H__
19#define __XFS_IOMAP_H__
20
21#define IOMAP_DADDR_NULL ((xfs_daddr_t) (-1LL))
22
23
24typedef enum { /* iomap_flags values */
25 IOMAP_EOF = 0x01, /* mapping contains EOF */
26 IOMAP_HOLE = 0x02, /* mapping covers a hole */
27 IOMAP_DELAY = 0x04, /* mapping covers delalloc region */
28 IOMAP_REALTIME = 0x10, /* mapping on the realtime device */
29 IOMAP_UNWRITTEN = 0x20, /* mapping covers allocated */
30 /* but uninitialized file data */
31 IOMAP_NEW = 0x40 /* just allocate */
32} iomap_flags_t;
33
34typedef enum {
35 /* base extent manipulation calls */
36 BMAPI_READ = (1 << 0), /* read extents */
37 BMAPI_WRITE = (1 << 1), /* create extents */
38 BMAPI_ALLOCATE = (1 << 2), /* delayed allocate to real extents */
39 BMAPI_UNWRITTEN = (1 << 3), /* unwritten extents to real extents */
40 /* modifiers */
41 BMAPI_IGNSTATE = (1 << 4), /* ignore unwritten state on read */
Nathan Scott24e17b52005-05-05 13:33:20 -070042 BMAPI_DIRECT = (1 << 5), /* direct instead of buffered write */
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 BMAPI_MMAP = (1 << 6), /* allocate for mmap write */
44 BMAPI_SYNC = (1 << 7), /* sync write to flush delalloc space */
45 BMAPI_TRYLOCK = (1 << 8), /* non-blocking request */
46 BMAPI_DEVICE = (1 << 9), /* we only want to know the device */
47} bmapi_flags_t;
48
49
50/*
51 * xfs_iomap_t: File system I/O map
52 *
Nathan Scottf403b7f2005-05-05 13:33:40 -070053 * The iomap_bn field is expressed in 512-byte blocks, and is where the
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * mapping starts on disk.
55 *
56 * The iomap_offset, iomap_bsize and iomap_delta fields are in bytes.
57 * iomap_offset is the offset of the mapping in the file itself.
Nathan Scottf403b7f2005-05-05 13:33:40 -070058 * iomap_bsize is the size of the mapping, iomap_delta is the
59 * desired data's offset into the mapping, given the offset supplied
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 * to the file I/O map routine.
61 *
62 * When a request is made to read beyond the logical end of the object,
63 * iomap_size may be set to 0, but iomap_offset and iomap_length should be set
64 * to the actual amount of underlying storage that has been allocated, if any.
65 */
66
67typedef struct xfs_iomap {
68 xfs_daddr_t iomap_bn; /* first 512b blk of mapping */
69 xfs_buftarg_t *iomap_target;
Nathan Scottf403b7f2005-05-05 13:33:40 -070070 xfs_off_t iomap_offset; /* offset of mapping, bytes */
71 xfs_off_t iomap_bsize; /* size of mapping, bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 size_t iomap_delta; /* offset into mapping, bytes */
73 iomap_flags_t iomap_flags;
74} xfs_iomap_t;
75
76struct xfs_iocore;
77struct xfs_inode;
78struct xfs_bmbt_irec;
79
80extern int xfs_iomap(struct xfs_iocore *, xfs_off_t, ssize_t, int,
81 struct xfs_iomap *, int *);
Nathan Scottf403b7f2005-05-05 13:33:40 -070082extern int xfs_iomap_write_direct(struct xfs_inode *, xfs_off_t, size_t,
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 int, struct xfs_bmbt_irec *, int *, int);
Nathan Scottf403b7f2005-05-05 13:33:40 -070084extern int xfs_iomap_write_delay(struct xfs_inode *, xfs_off_t, size_t, int,
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 struct xfs_bmbt_irec *, int *);
Nathan Scottf403b7f2005-05-05 13:33:40 -070086extern int xfs_iomap_write_allocate(struct xfs_inode *, xfs_off_t, size_t,
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 struct xfs_bmbt_irec *, int *);
Nathan Scottf403b7f2005-05-05 13:33:40 -070088extern int xfs_iomap_write_unwritten(struct xfs_inode *, xfs_off_t, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90#endif /* __XFS_IOMAP_H__*/