blob: d2f3b67d39f925adf959902d20a993bf67f818c5 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070021typedef enum { /* iomap_flags values */
Lachlan McIlroyba87ea62007-05-08 13:49:46 +100022 IOMAP_READ = 0, /* mapping for a read */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 IOMAP_DELAY = 0x04, /* mapping covers delalloc region */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 IOMAP_UNWRITTEN = 0x20, /* mapping covers allocated */
25 /* but uninitialized file data */
26 IOMAP_NEW = 0x40 /* just allocate */
27} iomap_flags_t;
28
29typedef enum {
30 /* base extent manipulation calls */
31 BMAPI_READ = (1 << 0), /* read extents */
32 BMAPI_WRITE = (1 << 1), /* create extents */
33 BMAPI_ALLOCATE = (1 << 2), /* delayed allocate to real extents */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 /* modifiers */
35 BMAPI_IGNSTATE = (1 << 4), /* ignore unwritten state on read */
Nathan Scott24e17b52005-05-05 13:33:20 -070036 BMAPI_DIRECT = (1 << 5), /* direct instead of buffered write */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 BMAPI_MMAP = (1 << 6), /* allocate for mmap write */
Dave Chinner8de2bf92009-04-06 18:49:12 +020038 BMAPI_TRYLOCK = (1 << 7), /* non-blocking request */
Linus Torvalds1da177e2005-04-16 15:20:36 -070039} bmapi_flags_t;
40
Christoph Hellwig0b1b2132009-12-14 23:14:59 +000041#define BMAPI_FLAGS \
42 { BMAPI_READ, "READ" }, \
43 { BMAPI_WRITE, "WRITE" }, \
44 { BMAPI_ALLOCATE, "ALLOCATE" }, \
45 { BMAPI_IGNSTATE, "IGNSTATE" }, \
46 { BMAPI_DIRECT, "DIRECT" }, \
47 { BMAPI_MMAP, "MMAP" }, \
48 { BMAPI_TRYLOCK, "TRYLOCK" }
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
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 {
Malcolm Parsons9da096f2009-03-29 09:55:42 +020068 xfs_daddr_t iomap_bn; /* first 512B blk of mapping */
Nathan Scottf403b7f2005-05-05 13:33:40 -070069 xfs_off_t iomap_offset; /* offset of mapping, bytes */
70 xfs_off_t iomap_bsize; /* size of mapping, bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 iomap_flags_t iomap_flags;
72} xfs_iomap_t;
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074struct xfs_inode;
75struct xfs_bmbt_irec;
76
Lachlan McIlroy541d7d32007-10-11 17:34:33 +100077extern int xfs_iomap(struct xfs_inode *, xfs_off_t, ssize_t, int,
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 struct xfs_iomap *, int *);
Nathan Scottf403b7f2005-05-05 13:33:40 -070079extern int xfs_iomap_write_direct(struct xfs_inode *, xfs_off_t, size_t,
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 int, struct xfs_bmbt_irec *, int *, int);
Nathan Scottf403b7f2005-05-05 13:33:40 -070081extern int xfs_iomap_write_delay(struct xfs_inode *, xfs_off_t, size_t, int,
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 struct xfs_bmbt_irec *, int *);
Nathan Scottf403b7f2005-05-05 13:33:40 -070083extern int xfs_iomap_write_allocate(struct xfs_inode *, xfs_off_t, size_t,
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 struct xfs_bmbt_irec *, int *);
Nathan Scottf403b7f2005-05-05 13:33:40 -070085extern int xfs_iomap_write_unwritten(struct xfs_inode *, xfs_off_t, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87#endif /* __XFS_IOMAP_H__*/