include/linux/iomap.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef LINUX_IOMAP_H
   3 #define LINUX_IOMAP_H 1
   4
   5 #include <linux/types.h>
   6
   7 struct fiemap_extent_info;
   8 struct inode;
   9 struct iov_iter;
  10 struct kiocb;
  11 struct vm_area_struct;
  12 struct vm_fault;
  13
  14 /*
  15  * Types of block ranges for iomap mappings:
  16  */
  17 #define IOMAP_HOLE      0x01    /* no blocks allocated, need allocation */
  18 #define IOMAP_DELALLOC  0x02    /* delayed allocation blocks */
  19 #define IOMAP_MAPPED    0x03    /* blocks allocated at @addr */
  20 #define IOMAP_UNWRITTEN 0x04    /* blocks allocated at @addr in unwritten state */
  21
  22 /*
  23  * Flags for all iomap mappings:
  24  */
  25 #define IOMAP_F_NEW     0x01    /* blocks have been newly allocated */
  26
  27 /*
  28  * Flags that only need to be reported for IOMAP_REPORT requests:
  29  */
  30 #define IOMAP_F_MERGED          0x10    /* contains multiple blocks/extents */
  31 #define IOMAP_F_SHARED          0x20    /* block shared with another file */
  32 #define IOMAP_F_DATA_INLINE     0x40    /* data inline in the inode */
  33
  34 /*
  35  * Magic value for addr:
  36  */
  37 #define IOMAP_NULL_ADDR -1ULL   /* addr is not valid */
  38
  39 struct iomap {
  40         u64                     addr; /* disk offset of mapping, bytes */
  41         loff_t                  offset; /* file offset of mapping, bytes */
  42         u64                     length; /* length of mapping, bytes */
  43         u16                     type;   /* type of mapping */
  44         u16                     flags;  /* flags for mapping */
  45         struct block_device     *bdev;  /* block device for I/O */
  46         struct dax_device       *dax_dev; /* dax_dev for dax operations */
  47 };
  48
  49 /*
  50  * Flags for iomap_begin / iomap_end.  No flag implies a read.
  51  */
  52 #define IOMAP_WRITE             (1 << 0) /* writing, must allocate blocks */
  53 #define IOMAP_ZERO              (1 << 1) /* zeroing operation, may skip holes */
  54 #define IOMAP_REPORT            (1 << 2) /* report extent status, e.g. FIEMAP */
  55 #define IOMAP_FAULT             (1 << 3) /* mapping for page fault */
  56 #define IOMAP_DIRECT            (1 << 4) /* direct I/O */
  57 #define IOMAP_NOWAIT            (1 << 5) /* Don't wait for writeback */
  58
  59 struct iomap_ops {
  60         /*
  61          * Return the existing mapping at pos, or reserve space starting at
  62          * pos for up to length, as long as we can do it as a single mapping.
  63          * The actual length is returned in iomap->length.
  64          */
  65         int (*iomap_begin)(struct inode *inode, loff_t pos, loff_t length,
  66                         unsigned flags, struct iomap *iomap);
  67
  68         /*
  69          * Commit and/or unreserve space previous allocated using iomap_begin.
  70          * Written indicates the length of the successful write operation which
  71          * needs to be commited, while the rest needs to be unreserved.
  72          * Written might be zero if no data was written.
  73          */
  74         int (*iomap_end)(struct inode *inode, loff_t pos, loff_t length,
  75                         ssize_t written, unsigned flags, struct iomap *iomap);
  76 };
  77
  78 ssize_t iomap_file_buffered_write(struct kiocb *iocb, struct iov_iter *from,
  79                 const struct iomap_ops *ops);
  80 int iomap_file_dirty(struct inode *inode, loff_t pos, loff_t len,
  81                 const struct iomap_ops *ops);
  82 int iomap_zero_range(struct inode *inode, loff_t pos, loff_t len,
  83                 bool *did_zero, const struct iomap_ops *ops);
  84 int iomap_truncate_page(struct inode *inode, loff_t pos, bool *did_zero,
  85                 const struct iomap_ops *ops);
  86 int iomap_page_mkwrite(struct vm_fault *vmf, const struct iomap_ops *ops);
  87 int iomap_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
  88                 loff_t start, loff_t len, const struct iomap_ops *ops);
  89 loff_t iomap_seek_hole(struct inode *inode, loff_t offset,
  90                 const struct iomap_ops *ops);
  91 loff_t iomap_seek_data(struct inode *inode, loff_t offset,
  92                 const struct iomap_ops *ops);
  93
  94 /*
  95  * Flags for direct I/O ->end_io:
  96  */
  97 #define IOMAP_DIO_UNWRITTEN     (1 << 0)        /* covers unwritten extent(s) */
  98 #define IOMAP_DIO_COW           (1 << 1)        /* covers COW extent(s) */
  99 typedef int (iomap_dio_end_io_t)(struct kiocb *iocb, ssize_t ret,
 100                 unsigned flags);
 101 ssize_t iomap_dio_rw(struct kiocb *iocb, struct iov_iter *iter,
 102                 const struct iomap_ops *ops, iomap_dio_end_io_t end_io);
 103
 104 #endif /* LINUX_IOMAP_H */