libfuse
fuse_lowlevel.h
Go to the documentation of this file.
1 /*
2  FUSE: Filesystem in Userspace
3  Copyright (C) 2001-2007 Miklos Szeredi <miklos@szeredi.hu>
4 
5  This program can be distributed under the terms of the GNU LGPLv2.
6  See the file COPYING.LIB.
7 */
8 
9 #ifndef FUSE_LOWLEVEL_H_
10 #define FUSE_LOWLEVEL_H_
11 
21 #ifndef FUSE_USE_VERSION
22 #error FUSE_USE_VERSION not defined
23 #endif
24 
25 #include "fuse_common.h"
26 
27 #include <utime.h>
28 #include <fcntl.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31 #include <sys/statvfs.h>
32 #include <sys/uio.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /* ----------------------------------------------------------- *
39  * Miscellaneous definitions *
40  * ----------------------------------------------------------- */
41 
43 #define FUSE_ROOT_ID 1
44 
46 typedef uint64_t fuse_ino_t;
47 
49 typedef struct fuse_req *fuse_req_t;
50 
56 struct fuse_session;
57 
67  fuse_ino_t ino;
68 
79  uint64_t generation;
80 
88  struct stat attr;
89 
94  double attr_timeout;
95 
101 };
102 
111 struct fuse_ctx {
113  uid_t uid;
114 
116  gid_t gid;
117 
119  pid_t pid;
120 
122  mode_t umask;
123 };
124 
125 struct fuse_forget_data {
126  fuse_ino_t ino;
127  uint64_t nlookup;
128 };
129 
130 /* 'to_set' flags in setattr */
131 #define FUSE_SET_ATTR_MODE (1 << 0)
132 #define FUSE_SET_ATTR_UID (1 << 1)
133 #define FUSE_SET_ATTR_GID (1 << 2)
134 #define FUSE_SET_ATTR_SIZE (1 << 3)
135 #define FUSE_SET_ATTR_ATIME (1 << 4)
136 #define FUSE_SET_ATTR_MTIME (1 << 5)
137 #define FUSE_SET_ATTR_ATIME_NOW (1 << 7)
138 #define FUSE_SET_ATTR_MTIME_NOW (1 << 8)
139 #define FUSE_SET_ATTR_CTIME (1 << 10)
140 
141 /* ----------------------------------------------------------- *
142  * Request methods and replies *
143  * ----------------------------------------------------------- */
144 
189  void (*init) (void *userdata, struct fuse_conn_info *conn);
190 
202  void (*destroy) (void *userdata);
203 
215  void (*lookup) (fuse_req_t req, fuse_ino_t parent, const char *name);
216 
253  void (*forget) (fuse_req_t req, fuse_ino_t ino, uint64_t nlookup);
254 
274  void (*getattr) (fuse_req_t req, fuse_ino_t ino,
275  struct fuse_file_info *fi);
276 
305  void (*setattr) (fuse_req_t req, fuse_ino_t ino, struct stat *attr,
306  int to_set, struct fuse_file_info *fi);
307 
318  void (*readlink) (fuse_req_t req, fuse_ino_t ino);
319 
336  void (*mknod) (fuse_req_t req, fuse_ino_t parent, const char *name,
337  mode_t mode, dev_t rdev);
338 
351  void (*mkdir) (fuse_req_t req, fuse_ino_t parent, const char *name,
352  mode_t mode);
353 
369  void (*unlink) (fuse_req_t req, fuse_ino_t parent, const char *name);
370 
386  void (*rmdir) (fuse_req_t req, fuse_ino_t parent, const char *name);
387 
400  void (*symlink) (fuse_req_t req, const char *link, fuse_ino_t parent,
401  const char *name);
402 
432  void (*rename) (fuse_req_t req, fuse_ino_t parent, const char *name,
433  fuse_ino_t newparent, const char *newname,
434  unsigned int flags);
435 
448  void (*link) (fuse_req_t req, fuse_ino_t ino, fuse_ino_t newparent,
449  const char *newname);
450 
507  void (*open) (fuse_req_t req, fuse_ino_t ino,
508  struct fuse_file_info *fi);
509 
535  void (*read) (fuse_req_t req, fuse_ino_t ino, size_t size, off_t off,
536  struct fuse_file_info *fi);
537 
564  void (*write) (fuse_req_t req, fuse_ino_t ino, const char *buf,
565  size_t size, off_t off, struct fuse_file_info *fi);
566 
605  void (*flush) (fuse_req_t req, fuse_ino_t ino,
606  struct fuse_file_info *fi);
607 
633  void (*release) (fuse_req_t req, fuse_ino_t ino,
634  struct fuse_file_info *fi);
635 
655  void (*fsync) (fuse_req_t req, fuse_ino_t ino, int datasync,
656  struct fuse_file_info *fi);
657 
680  void (*opendir) (fuse_req_t req, fuse_ino_t ino,
681  struct fuse_file_info *fi);
682 
726  void (*readdir) (fuse_req_t req, fuse_ino_t ino, size_t size, off_t off,
727  struct fuse_file_info *fi);
728 
745  void (*releasedir) (fuse_req_t req, fuse_ino_t ino,
746  struct fuse_file_info *fi);
747 
770  void (*fsyncdir) (fuse_req_t req, fuse_ino_t ino, int datasync,
771  struct fuse_file_info *fi);
772 
783  void (*statfs) (fuse_req_t req, fuse_ino_t ino);
784 
796  void (*setxattr) (fuse_req_t req, fuse_ino_t ino, const char *name,
797  const char *value, size_t size, int flags);
798 
827  void (*getxattr) (fuse_req_t req, fuse_ino_t ino, const char *name,
828  size_t size);
829 
858  void (*listxattr) (fuse_req_t req, fuse_ino_t ino, size_t size);
859 
875  void (*removexattr) (fuse_req_t req, fuse_ino_t ino, const char *name);
876 
897  void (*access) (fuse_req_t req, fuse_ino_t ino, int mask);
898 
926  void (*create) (fuse_req_t req, fuse_ino_t parent, const char *name,
927  mode_t mode, struct fuse_file_info *fi);
928 
941  void (*getlk) (fuse_req_t req, fuse_ino_t ino,
942  struct fuse_file_info *fi, struct flock *lock);
943 
966  void (*setlk) (fuse_req_t req, fuse_ino_t ino,
967  struct fuse_file_info *fi,
968  struct flock *lock, int sleep);
969 
990  void (*bmap) (fuse_req_t req, fuse_ino_t ino, size_t blocksize,
991  uint64_t idx);
992 
1021  void (*ioctl) (fuse_req_t req, fuse_ino_t ino, unsigned int cmd,
1022  void *arg, struct fuse_file_info *fi, unsigned flags,
1023  const void *in_buf, size_t in_bufsz, size_t out_bufsz);
1024 
1054  void (*poll) (fuse_req_t req, fuse_ino_t ino, struct fuse_file_info *fi,
1055  struct fuse_pollhandle *ph);
1056 
1084  void (*write_buf) (fuse_req_t req, fuse_ino_t ino,
1085  struct fuse_bufvec *bufv, off_t off,
1086  struct fuse_file_info *fi);
1087 
1100  void (*retrieve_reply) (fuse_req_t req, void *cookie, fuse_ino_t ino,
1101  off_t offset, struct fuse_bufvec *bufv);
1102 
1114  void (*forget_multi) (fuse_req_t req, size_t count,
1115  struct fuse_forget_data *forgets);
1116 
1132  void (*flock) (fuse_req_t req, fuse_ino_t ino,
1133  struct fuse_file_info *fi, int op);
1134 
1155  void (*fallocate) (fuse_req_t req, fuse_ino_t ino, int mode,
1156  off_t offset, off_t length, struct fuse_file_info *fi);
1157 
1183  void (*readdirplus) (fuse_req_t req, fuse_ino_t ino, size_t size, off_t off,
1184  struct fuse_file_info *fi);
1185 
1216  void (*copy_file_range) (fuse_req_t req, fuse_ino_t ino_in,
1217  off_t off_in, struct fuse_file_info *fi_in,
1218  fuse_ino_t ino_out, off_t off_out,
1219  struct fuse_file_info *fi_out, size_t len,
1220  int flags);
1221 };
1222 
1244 int fuse_reply_err(fuse_req_t req, int err);
1245 
1256 void fuse_reply_none(fuse_req_t req);
1257 
1271 int fuse_reply_entry(fuse_req_t req, const struct fuse_entry_param *e);
1272 
1290 int fuse_reply_create(fuse_req_t req, const struct fuse_entry_param *e,
1291  const struct fuse_file_info *fi);
1292 
1304 int fuse_reply_attr(fuse_req_t req, const struct stat *attr,
1305  double attr_timeout);
1306 
1317 int fuse_reply_readlink(fuse_req_t req, const char *link);
1318 
1332 int fuse_reply_open(fuse_req_t req, const struct fuse_file_info *fi);
1333 
1344 int fuse_reply_write(fuse_req_t req, size_t count);
1345 
1357 int fuse_reply_buf(fuse_req_t req, const char *buf, size_t size);
1358 
1402 int fuse_reply_data(fuse_req_t req, struct fuse_bufvec *bufv,
1403  enum fuse_buf_copy_flags flags);
1404 
1416 int fuse_reply_iov(fuse_req_t req, const struct iovec *iov, int count);
1417 
1428 int fuse_reply_statfs(fuse_req_t req, const struct statvfs *stbuf);
1429 
1440 int fuse_reply_xattr(fuse_req_t req, size_t count);
1441 
1452 int fuse_reply_lock(fuse_req_t req, const struct flock *lock);
1453 
1464 int fuse_reply_bmap(fuse_req_t req, uint64_t idx);
1465 
1466 /* ----------------------------------------------------------- *
1467  * Filling a buffer in readdir *
1468  * ----------------------------------------------------------- */
1469 
1497 size_t fuse_add_direntry(fuse_req_t req, char *buf, size_t bufsize,
1498  const char *name, const struct stat *stbuf,
1499  off_t off);
1500 
1514 size_t fuse_add_direntry_plus(fuse_req_t req, char *buf, size_t bufsize,
1515  const char *name,
1516  const struct fuse_entry_param *e, off_t off);
1517 
1533 int fuse_reply_ioctl_retry(fuse_req_t req,
1534  const struct iovec *in_iov, size_t in_count,
1535  const struct iovec *out_iov, size_t out_count);
1536 
1548 int fuse_reply_ioctl(fuse_req_t req, int result, const void *buf, size_t size);
1549 
1561 int fuse_reply_ioctl_iov(fuse_req_t req, int result, const struct iovec *iov,
1562  int count);
1563 
1570 int fuse_reply_poll(fuse_req_t req, unsigned revents);
1571 
1572 /* ----------------------------------------------------------- *
1573  * Notification *
1574  * ----------------------------------------------------------- */
1575 
1583 int fuse_lowlevel_notify_poll(struct fuse_pollhandle *ph);
1584 
1608 int fuse_lowlevel_notify_inval_inode(struct fuse_session *se, fuse_ino_t ino,
1609  off_t off, off_t len);
1610 
1636 int fuse_lowlevel_notify_inval_entry(struct fuse_session *se, fuse_ino_t parent,
1637  const char *name, size_t namelen);
1638 
1667 int fuse_lowlevel_notify_delete(struct fuse_session *se,
1668  fuse_ino_t parent, fuse_ino_t child,
1669  const char *name, size_t namelen);
1670 
1696 int fuse_lowlevel_notify_store(struct fuse_session *se, fuse_ino_t ino,
1697  off_t offset, struct fuse_bufvec *bufv,
1698  enum fuse_buf_copy_flags flags);
1728 int fuse_lowlevel_notify_retrieve(struct fuse_session *se, fuse_ino_t ino,
1729  size_t size, off_t offset, void *cookie);
1730 
1731 
1732 /* ----------------------------------------------------------- *
1733  * Utility functions *
1734  * ----------------------------------------------------------- */
1735 
1742 void *fuse_req_userdata(fuse_req_t req);
1743 
1753 const struct fuse_ctx *fuse_req_ctx(fuse_req_t req);
1754 
1774 int fuse_req_getgroups(fuse_req_t req, int size, gid_t list[]);
1775 
1782 typedef void (*fuse_interrupt_func_t)(fuse_req_t req, void *data);
1783 
1795 void fuse_req_interrupt_func(fuse_req_t req, fuse_interrupt_func_t func,
1796  void *data);
1797 
1804 int fuse_req_interrupted(fuse_req_t req);
1805 
1806 
1807 /* ----------------------------------------------------------- *
1808  * Inquiry functions *
1809  * ----------------------------------------------------------- */
1810 
1814 void fuse_lowlevel_version(void);
1815 
1821 void fuse_lowlevel_help(void);
1822 
1826 void fuse_cmdline_help(void);
1827 
1828 /* ----------------------------------------------------------- *
1829  * Filesystem setup & teardown *
1830  * ----------------------------------------------------------- */
1831 
1832 struct fuse_cmdline_opts {
1833  int singlethread;
1834  int foreground;
1835  int debug;
1836  int nodefault_subtype;
1837  char *mountpoint;
1838  int show_version;
1839  int show_help;
1840  int clone_fd;
1841  unsigned int max_idle_threads;
1842 };
1843 
1862 int fuse_parse_cmdline(struct fuse_args *args,
1863  struct fuse_cmdline_opts *opts);
1864 
1893 struct fuse_session *fuse_session_new(struct fuse_args *args,
1894  const struct fuse_lowlevel_ops *op,
1895  size_t op_size, void *userdata);
1896 
1905 int fuse_session_mount(struct fuse_session *se, const char *mountpoint);
1906 
1929 int fuse_session_loop(struct fuse_session *se);
1930 
1942 #if FUSE_USE_VERSION < 32
1943 int fuse_session_loop_mt_31(struct fuse_session *se, int clone_fd);
1944 #define fuse_session_loop_mt(se, clone_fd) fuse_session_loop_mt_31(se, clone_fd)
1945 #else
1946 int fuse_session_loop_mt(struct fuse_session *se, struct fuse_loop_config *config);
1947 #endif
1948 
1958 void fuse_session_exit(struct fuse_session *se);
1959 
1965 void fuse_session_reset(struct fuse_session *se);
1966 
1973 int fuse_session_exited(struct fuse_session *se);
1974 
1999 void fuse_session_unmount(struct fuse_session *se);
2000 
2006 void fuse_session_destroy(struct fuse_session *se);
2007 
2008 /* ----------------------------------------------------------- *
2009  * Custom event loop support *
2010  * ----------------------------------------------------------- */
2011 
2026 int fuse_session_fd(struct fuse_session *se);
2027 
2036 void fuse_session_process_buf(struct fuse_session *se,
2037  const struct fuse_buf *buf);
2038 
2050 int fuse_session_receive_buf(struct fuse_session *se, struct fuse_buf *buf);
2051 
2052 #ifdef __cplusplus
2053 }
2054 #endif
2055 
2056 #endif /* FUSE_LOWLEVEL_H_ */
void fuse_session_destroy(struct fuse_session *se)
int fuse_reply_err(fuse_req_t req, int err)
size_t off
Definition: fuse_common.h:710
int fuse_session_receive_buf(struct fuse_session *se, struct fuse_buf *buf)
struct fuse_session * fuse_session_new(struct fuse_args *args, const struct fuse_lowlevel_ops *op, size_t op_size, void *userdata)
void fuse_session_exit(struct fuse_session *se)
int fuse_session_loop(struct fuse_session *se)
Definition: fuse_loop.c:19
int fuse_lowlevel_notify_retrieve(struct fuse_session *se, fuse_ino_t ino, size_t size, off_t offset, void *cookie)
int fuse_lowlevel_notify_delete(struct fuse_session *se, fuse_ino_t parent, fuse_ino_t child, const char *name, size_t namelen)
int fuse_reply_ioctl(fuse_req_t req, int result, const void *buf, size_t size)
void fuse_lowlevel_help(void)
size_t fuse_add_direntry_plus(fuse_req_t req, char *buf, size_t bufsize, const char *name, const struct fuse_entry_param *e, off_t off)
int fuse_reply_data(fuse_req_t req, struct fuse_bufvec *bufv, enum fuse_buf_copy_flags flags)
int fuse_session_fd(struct fuse_session *se)
const struct fuse_ctx * fuse_req_ctx(fuse_req_t req)
int fuse_session_mount(struct fuse_session *se, const char *mountpoint)
int fuse_reply_ioctl_retry(fuse_req_t req, const struct iovec *in_iov, size_t in_count, const struct iovec *out_iov, size_t out_count)
mode_t umask
void(* fuse_interrupt_func_t)(fuse_req_t req, void *data)
int fuse_lowlevel_notify_poll(struct fuse_pollhandle *ph)
struct fuse_req * fuse_req_t
Definition: fuse_lowlevel.h:49
struct stat attr
Definition: fuse_lowlevel.h:88
size_t fuse_add_direntry(fuse_req_t req, char *buf, size_t bufsize, const char *name, const struct stat *stbuf, off_t off)
void * fuse_req_userdata(fuse_req_t req)
int fuse_lowlevel_notify_inval_inode(struct fuse_session *se, fuse_ino_t ino, off_t off, off_t len)
int fuse_reply_bmap(fuse_req_t req, uint64_t idx)
int fuse_session_loop_mt_31(struct fuse_session *se, int clone_fd)
Definition: fuse_loop_mt.c:356
Definition: fuse_lowlevel.h:59
fuse_ino_t ino
Definition: fuse_lowlevel.h:67
int fuse_parse_cmdline(struct fuse_args *args, struct fuse_cmdline_opts *opts)
Definition: helper.c:202
int fuse_reply_xattr(fuse_req_t req, size_t count)
void fuse_cmdline_help(void)
Definition: helper.c:129
int fuse_session_exited(struct fuse_session *se)
int fuse_reply_entry(fuse_req_t req, const struct fuse_entry_param *e)
int fuse_lowlevel_notify_store(struct fuse_session *se, fuse_ino_t ino, off_t offset, struct fuse_bufvec *bufv, enum fuse_buf_copy_flags flags)
int fuse_reply_lock(fuse_req_t req, const struct flock *lock)
int fuse_req_interrupted(fuse_req_t req)
void fuse_session_reset(struct fuse_session *se)
void fuse_lowlevel_version(void)
int fuse_reply_ioctl_iov(fuse_req_t req, int result, const struct iovec *iov, int count)
void fuse_reply_none(fuse_req_t req)
int fuse_req_getgroups(fuse_req_t req, int size, gid_t list[])
size_t count
Definition: fuse_common.h:700
int fuse_lowlevel_notify_inval_entry(struct fuse_session *se, fuse_ino_t parent, const char *name, size_t namelen)
int fuse_reply_attr(fuse_req_t req, const struct stat *attr, double attr_timeout)
void fuse_session_unmount(struct fuse_session *se)
int fuse_reply_statfs(fuse_req_t req, const struct statvfs *stbuf)
unsigned int flush
Definition: fuse_common.h:68
uint64_t fuse_ino_t
Definition: fuse_lowlevel.h:46
void fuse_req_interrupt_func(fuse_req_t req, fuse_interrupt_func_t func, void *data)
uint64_t generation
Definition: fuse_lowlevel.h:79
int fuse_reply_create(fuse_req_t req, const struct fuse_entry_param *e, const struct fuse_file_info *fi)
int fuse_reply_write(fuse_req_t req, size_t count)
int fuse_reply_open(fuse_req_t req, const struct fuse_file_info *fi)
double entry_timeout
fuse_buf_copy_flags
Definition: fuse_common.h:610
double attr_timeout
Definition: fuse_lowlevel.h:94
int fuse_reply_iov(fuse_req_t req, const struct iovec *iov, int count)
int fuse_reply_readlink(fuse_req_t req, const char *link)
int fuse_reply_buf(fuse_req_t req, const char *buf, size_t size)
int fuse_reply_poll(fuse_req_t req, unsigned revents)
void fuse_session_process_buf(struct fuse_session *se, const struct fuse_buf *buf)