include/sys/zfs_file.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or https://opensource.org/licenses/CDDL-1.0.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 #ifndef _SYS_ZFS_FILE_H
  23 #define _SYS_ZFS_FILE_H
  24
  25 #include <sys/zfs_context.h>
  26
  27 #ifndef _KERNEL
  28 typedef struct zfs_file {
  29         int f_fd;
  30         int f_dump_fd;
  31 } zfs_file_t;
  32 #elif defined(__linux__) || defined(__FreeBSD__)
  33 typedef struct file zfs_file_t;
  34 #else
  35 #error "unknown OS"
  36 #endif
  37
  38 typedef struct zfs_file_attr {
  39         uint64_t        zfa_size;       /* file size */
  40         mode_t          zfa_mode;       /* file type */
  41 } zfs_file_attr_t;
  42
  43 int zfs_file_open(const char *path, int flags, int mode, zfs_file_t **fp);
  44 void zfs_file_close(zfs_file_t *fp);
  45
  46 int zfs_file_write(zfs_file_t *fp, const void *buf, size_t len, ssize_t *resid);
  47 int zfs_file_pwrite(zfs_file_t *fp, const void *buf, size_t len, loff_t off,
  48     ssize_t *resid);
  49 int zfs_file_read(zfs_file_t *fp, void *buf, size_t len, ssize_t *resid);
  50 int zfs_file_pread(zfs_file_t *fp, void *buf, size_t len, loff_t off,
  51     ssize_t *resid);
  52
  53 int zfs_file_seek(zfs_file_t *fp, loff_t *offp, int whence);
  54 int zfs_file_getattr(zfs_file_t *fp, zfs_file_attr_t *zfattr);
  55 int zfs_file_fsync(zfs_file_t *fp, int flags);
  56 int zfs_file_fallocate(zfs_file_t *fp, int mode, loff_t offset, loff_t len);
  57 loff_t zfs_file_off(zfs_file_t *fp);
  58 int zfs_file_unlink(const char *);
  59
  60 zfs_file_t *zfs_file_get(int fd);
  61 void zfs_file_put(zfs_file_t *fp);
  62 void *zfs_file_private(zfs_file_t *fp);
  63
  64 #endif /* _SYS_ZFS_FILE_H */