"Fossies" - the Fresh Open Source Software Archive

Member "fuse-3.3.0/doc/html/fuse_8h_source.html" (6 Nov 2018, 96542 Bytes) of package /linux/misc/fuse-3.3.0.tar.xz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. Alternatively you can here view or download the uninterpreted raw source code. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

libfuse
fuse.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_H_
10 #define FUSE_H_
11 
19 #include "fuse_common.h"
20 
21 #include <fcntl.h>
22 #include <time.h>
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #include <sys/statvfs.h>
26 #include <sys/uio.h>
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 /* ----------------------------------------------------------- *
33  * Basic FUSE API *
34  * ----------------------------------------------------------- */
35 
37 struct fuse;
38 
51  FUSE_READDIR_PLUS = (1 << 0),
52 };
53 
64  FUSE_FILL_DIR_PLUS = (1 << 1),
65 };
66 
82 typedef int (*fuse_fill_dir_t) (void *buf, const char *name,
83  const struct stat *stbuf, off_t off,
84  enum fuse_fill_dir_flags flags);
93 struct fuse_config {
98  int set_gid;
99  unsigned int gid;
100 
105  int set_uid;
106  unsigned int uid;
107 
112  int set_mode;
113  unsigned int umask;
114 
120 
130 
135  double attr_timeout;
136 
140  int intr;
141 
148 
159  int remember;
160 
178 
190  int use_ino;
191 
200 
219 
238 
246 
253  double ac_attr_timeout;
254 
266 
272  char *modules;
273  int debug;
274 };
275 
276 
311  int (*getattr) (const char *, struct stat *, struct fuse_file_info *fi);
312 
321  int (*readlink) (const char *, char *, size_t);
322 
329  int (*mknod) (const char *, mode_t, dev_t);
330 
337  int (*mkdir) (const char *, mode_t);
338 
340  int (*unlink) (const char *);
341 
343  int (*rmdir) (const char *);
344 
346  int (*symlink) (const char *, const char *);
347 
357  int (*rename) (const char *, const char *, unsigned int flags);
358 
360  int (*link) (const char *, const char *);
361 
367  int (*chmod) (const char *, mode_t, struct fuse_file_info *fi);
368 
377  int (*chown) (const char *, uid_t, gid_t, struct fuse_file_info *fi);
378 
387  int (*truncate) (const char *, off_t, struct fuse_file_info *fi);
388 
437  int (*open) (const char *, struct fuse_file_info *);
438 
448  int (*read) (const char *, char *, size_t, off_t,
449  struct fuse_file_info *);
450 
460  int (*write) (const char *, const char *, size_t, off_t,
461  struct fuse_file_info *);
462 
467  int (*statfs) (const char *, struct statvfs *);
468 
490  int (*flush) (const char *, struct fuse_file_info *);
491 
504  int (*release) (const char *, struct fuse_file_info *);
505 
511  int (*fsync) (const char *, int, struct fuse_file_info *);
512 
514  int (*setxattr) (const char *, const char *, const char *, size_t, int);
515 
517  int (*getxattr) (const char *, const char *, char *, size_t);
518 
520  int (*listxattr) (const char *, char *, size_t);
521 
523  int (*removexattr) (const char *, const char *);
524 
533  int (*opendir) (const char *, struct fuse_file_info *);
534 
550  int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
551  struct fuse_file_info *, enum fuse_readdir_flags);
552 
555  int (*releasedir) (const char *, struct fuse_file_info *);
556 
562  int (*fsyncdir) (const char *, int, struct fuse_file_info *);
563 
572  void *(*init) (struct fuse_conn_info *conn,
573  struct fuse_config *cfg);
574 
580  void (*destroy) (void *private_data);
581 
591  int (*access) (const char *, int);
592 
603  int (*create) (const char *, mode_t, struct fuse_file_info *);
604 
635  int (*lock) (const char *, struct fuse_file_info *, int cmd,
636  struct flock *);
637 
650  int (*utimens) (const char *, const struct timespec tv[2],
651  struct fuse_file_info *fi);
652 
659  int (*bmap) (const char *, size_t blocksize, uint64_t *idx);
660 
674  int (*ioctl) (const char *, int cmd, void *arg,
675  struct fuse_file_info *, unsigned int flags, void *data);
676 
692  int (*poll) (const char *, struct fuse_file_info *,
693  struct fuse_pollhandle *ph, unsigned *reventsp);
694 
704  int (*write_buf) (const char *, struct fuse_bufvec *buf, off_t off,
705  struct fuse_file_info *);
706 
721  int (*read_buf) (const char *, struct fuse_bufvec **bufp,
722  size_t size, off_t off, struct fuse_file_info *);
741  int (*flock) (const char *, struct fuse_file_info *, int op);
742 
751  int (*fallocate) (const char *, int, off_t, off_t,
752  struct fuse_file_info *);
753 };
754 
760 struct fuse_context {
762  struct fuse *fuse;
763 
765  uid_t uid;
766 
768  gid_t gid;
769 
771  pid_t pid;
772 
775 
777  mode_t umask;
778 };
779 
834 /*
835  int fuse_main(int argc, char *argv[], const struct fuse_operations *op,
836  void *private_data);
837 */
838 #define fuse_main(argc, argv, op, private_data) \
839  fuse_main_real(argc, argv, op, sizeof(*(op)), private_data)
840 
841 /* ----------------------------------------------------------- *
842  * More detailed API *
843  * ----------------------------------------------------------- */
844 
856 void fuse_lib_help(struct fuse_args *args);
857 
885 #if FUSE_USE_VERSION == 30
886 struct fuse *fuse_new_30(struct fuse_args *args, const struct fuse_operations *op,
887  size_t op_size, void *private_data);
888 #define fuse_new(args, op, size, data) fuse_new_30(args, op, size, data)
889 #else
890 struct fuse *fuse_new(struct fuse_args *args, const struct fuse_operations *op,
891  size_t op_size, void *private_data);
892 #endif
893 
902 int fuse_mount(struct fuse *f, const char *mountpoint);
903 
911 void fuse_unmount(struct fuse *f);
912 
921 void fuse_destroy(struct fuse *f);
922 
938 int fuse_loop(struct fuse *f);
939 
948 void fuse_exit(struct fuse *f);
949 
981 #if FUSE_USE_VERSION < 32
982 int fuse_loop_mt_31(struct fuse *f, int clone_fd);
983 #define fuse_loop_mt(f, clone_fd) fuse_loop_mt_31(f, clone_fd)
984 #else
985 int fuse_loop_mt(struct fuse *f, struct fuse_loop_config *config);
986 #endif
987 
996 struct fuse_context *fuse_get_context(void);
997 
1016 int fuse_getgroups(int size, gid_t list[]);
1017 
1023 int fuse_interrupted(void);
1024 
1036 int fuse_invalidate_path(struct fuse *f, const char *path);
1037 
1043 int fuse_main_real(int argc, char *argv[], const struct fuse_operations *op,
1044  size_t op_size, void *private_data);
1045 
1053 int fuse_start_cleanup_thread(struct fuse *fuse);
1054 
1061 void fuse_stop_cleanup_thread(struct fuse *fuse);
1062 
1072 int fuse_clean_cache(struct fuse *fuse);
1073 
1074 /*
1075  * Stacking API
1076  */
1077 
1083 struct fuse_fs;
1084 
1085 /*
1086  * These functions call the relevant filesystem operation, and return
1087  * the result.
1088  *
1089  * If the operation is not defined, they return -ENOSYS, with the
1090  * exception of fuse_fs_open, fuse_fs_release, fuse_fs_opendir,
1091  * fuse_fs_releasedir and fuse_fs_statfs, which return 0.
1092  */
1093 
1094 int fuse_fs_getattr(struct fuse_fs *fs, const char *path, struct stat *buf,
1095  struct fuse_file_info *fi);
1096 int fuse_fs_rename(struct fuse_fs *fs, const char *oldpath,
1097  const char *newpath, unsigned int flags);
1098 int fuse_fs_unlink(struct fuse_fs *fs, const char *path);
1099 int fuse_fs_rmdir(struct fuse_fs *fs, const char *path);
1100 int fuse_fs_symlink(struct fuse_fs *fs, const char *linkname,
1101  const char *path);
1102 int fuse_fs_link(struct fuse_fs *fs, const char *oldpath, const char *newpath);
1103 int fuse_fs_release(struct fuse_fs *fs, const char *path,
1104  struct fuse_file_info *fi);
1105 int fuse_fs_open(struct fuse_fs *fs, const char *path,
1106  struct fuse_file_info *fi);
1107 int fuse_fs_read(struct fuse_fs *fs, const char *path, char *buf, size_t size,
1108  off_t off, struct fuse_file_info *fi);
1109 int fuse_fs_read_buf(struct fuse_fs *fs, const char *path,
1110  struct fuse_bufvec **bufp, size_t size, off_t off,
1111  struct fuse_file_info *fi);
1112 int fuse_fs_write(struct fuse_fs *fs, const char *path, const char *buf,
1113  size_t size, off_t off, struct fuse_file_info *fi);
1114 int fuse_fs_write_buf(struct fuse_fs *fs, const char *path,
1115  struct fuse_bufvec *buf, off_t off,
1116  struct fuse_file_info *fi);
1117 int fuse_fs_fsync(struct fuse_fs *fs, const char *path, int datasync,
1118  struct fuse_file_info *fi);
1119 int fuse_fs_flush(struct fuse_fs *fs, const char *path,
1120  struct fuse_file_info *fi);
1121 int fuse_fs_statfs(struct fuse_fs *fs, const char *path, struct statvfs *buf);
1122 int fuse_fs_opendir(struct fuse_fs *fs, const char *path,
1123  struct fuse_file_info *fi);
1124 int fuse_fs_readdir(struct fuse_fs *fs, const char *path, void *buf,
1125  fuse_fill_dir_t filler, off_t off,
1126  struct fuse_file_info *fi, enum fuse_readdir_flags flags);
1127 int fuse_fs_fsyncdir(struct fuse_fs *fs, const char *path, int datasync,
1128  struct fuse_file_info *fi);
1129 int fuse_fs_releasedir(struct fuse_fs *fs, const char *path,
1130  struct fuse_file_info *fi);
1131 int fuse_fs_create(struct fuse_fs *fs, const char *path, mode_t mode,
1132  struct fuse_file_info *fi);
1133 int fuse_fs_lock(struct fuse_fs *fs, const char *path,
1134  struct fuse_file_info *fi, int cmd, struct flock *lock);
1135 int fuse_fs_flock(struct fuse_fs *fs, const char *path,
1136  struct fuse_file_info *fi, int op);
1137 int fuse_fs_chmod(struct fuse_fs *fs, const char *path, mode_t mode,
1138  struct fuse_file_info *fi);
1139 int fuse_fs_chown(struct fuse_fs *fs, const char *path, uid_t uid, gid_t gid,
1140  struct fuse_file_info *fi);
1141 int fuse_fs_truncate(struct fuse_fs *fs, const char *path, off_t size,
1142  struct fuse_file_info *fi);
1143 int fuse_fs_utimens(struct fuse_fs *fs, const char *path,
1144  const struct timespec tv[2], struct fuse_file_info *fi);
1145 int fuse_fs_access(struct fuse_fs *fs, const char *path, int mask);
1146 int fuse_fs_readlink(struct fuse_fs *fs, const char *path, char *buf,
1147  size_t len);
1148 int fuse_fs_mknod(struct fuse_fs *fs, const char *path, mode_t mode,
1149  dev_t rdev);
1150 int fuse_fs_mkdir(struct fuse_fs *fs, const char *path, mode_t mode);
1151 int fuse_fs_setxattr(struct fuse_fs *fs, const char *path, const char *name,
1152  const char *value, size_t size, int flags);
1153 int fuse_fs_getxattr(struct fuse_fs *fs, const char *path, const char *name,
1154  char *value, size_t size);
1155 int fuse_fs_listxattr(struct fuse_fs *fs, const char *path, char *list,
1156  size_t size);
1157 int fuse_fs_removexattr(struct fuse_fs *fs, const char *path,
1158  const char *name);
1159 int fuse_fs_bmap(struct fuse_fs *fs, const char *path, size_t blocksize,
1160  uint64_t *idx);
1161 int fuse_fs_ioctl(struct fuse_fs *fs, const char *path, int cmd, void *arg,
1162  struct fuse_file_info *fi, unsigned int flags, void *data);
1163 int fuse_fs_poll(struct fuse_fs *fs, const char *path,
1164  struct fuse_file_info *fi, struct fuse_pollhandle *ph,
1165  unsigned *reventsp);
1166 int fuse_fs_fallocate(struct fuse_fs *fs, const char *path, int mode,
1167  off_t offset, off_t length, struct fuse_file_info *fi);
1168 void fuse_fs_init(struct fuse_fs *fs, struct fuse_conn_info *conn,
1169  struct fuse_config *cfg);
1170 void fuse_fs_destroy(struct fuse_fs *fs);
1171 
1172 int fuse_notify_poll(struct fuse_pollhandle *ph);
1173 
1187 struct fuse_fs *fuse_fs_new(const struct fuse_operations *op, size_t op_size,
1188  void *private_data);
1189 
1204 typedef struct fuse_fs *(*fuse_module_factory_t)(struct fuse_args *args,
1205  struct fuse_fs *fs[]);
1216 #define FUSE_REGISTER_MODULE(name_, factory_) \
1217  fuse_module_factory_t fuse_module_ ## name_ ## _factory = factory_
1218 
1220 struct fuse_session *fuse_get_session(struct fuse *f);
1221 
1230 int fuse_open_channel(const char *mountpoint, const char *options);
1231 
1232 #ifdef __cplusplus
1233 }
1234 #endif
1235 
1236 #endif /* FUSE_H_ */
size_t off
Definition: fuse_common.h:679
int auto_cache
Definition: fuse.h:245
void fuse_stop_cleanup_thread(struct fuse *fuse)
Definition: fuse.c:4753
int set_gid
Definition: fuse.h:98
int fuse_loop(struct fuse *f)
Definition: fuse.c:4453
struct fuse * fuse_new(struct fuse_args *args, const struct fuse_operations *op, size_t op_size, void *private_data)
fuse_fill_dir_flags
Definition: fuse.h:54
int readdir_ino
Definition: fuse.h:199
int intr
Definition: fuse.h:140
int set_mode
Definition: fuse.h:112
fuse_readdir_flags
Definition: fuse.h:42
int nullpath_ok
Definition: fuse.h:265
double negative_timeout
Definition: fuse.h:129
pid_t pid
Definition: fuse.h:771
int fuse_clean_cache(struct fuse *fuse)
Definition: fuse.c:4311
void fuse_destroy(struct fuse *f)
Definition: fuse.c:4944
int set_uid
Definition: fuse.h:105
int remember
Definition: fuse.h:159
int use_ino
Definition: fuse.h:190
int fuse_open_channel(const char *mountpoint, const char *options)
Definition: helper.c:424
gid_t gid
Definition: fuse.h:768
struct fuse_session * fuse_get_session(struct fuse *f)
Definition: fuse.c:4396
mode_t umask
Definition: fuse.h:777
void * private_data
Definition: fuse.h:774
int fuse_main_real(int argc, char *argv[], const struct fuse_operations *op, size_t op_size, void *private_data)
Definition: helper.c:279
int fuse_invalidate_path(struct fuse *f, const char *path)
Definition: fuse.c:4523
double attr_timeout
Definition: fuse.h:135
struct fuse_fs * fuse_fs_new(const struct fuse_operations *op, size_t op_size, void *private_data)
Definition: fuse.c:4697
int direct_io
Definition: fuse.h:218
int fuse_start_cleanup_thread(struct fuse *fuse)
Definition: fuse.c:4745
void fuse_lib_help(struct fuse_args *args)
Definition: fuse.c:4587
int fuse_interrupted(void)
Definition: fuse.c:4513
int(* fuse_fill_dir_t)(void *buf, const char *name, const struct stat *stbuf, off_t off, enum fuse_fill_dir_flags flags)
Definition: fuse.h:82
int show_help
Definition: fuse.h:271
int fuse_getgroups(int size, gid_t list[])
Definition: fuse.c:4504
int fuse_mount(struct fuse *f, const char *mountpoint)
Definition: fuse.c:4994
uid_t uid
Definition: fuse.h:765
struct fuse * fuse
Definition: fuse.h:762
struct fuse_buf buf[1]
Definition: fuse_common.h:684
int ac_attr_timeout_set
Definition: fuse.h:252
void fuse_unmount(struct fuse *f)
Definition: fuse.c:4999
int fuse_loop_mt_31(struct fuse *f, int clone_fd)
Definition: fuse.c:4481
struct fuse_context * fuse_get_context(void)
Definition: fuse.c:4494
double entry_timeout
Definition: fuse.h:119
int kernel_cache
Definition: fuse.h:237
int intr_signal
Definition: fuse.h:147
int hard_remove
Definition: fuse.h:177
void fuse_exit(struct fuse *f)
Definition: fuse.c:4489