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
42 enum fuse_readdir_flags {
51 FUSE_READDIR_PLUS = (1 << 0),
52 };
53
54 enum fuse_fill_dir_flags {
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
119 double entry_timeout;
120
129 double negative_timeout;
130
135 double attr_timeout;
136
140 int intr;
141
147 int intr_signal;
148
159 int remember;
160
177 int hard_remove;
178
190 int use_ino;
191
199 int readdir_ino;
200
218 int direct_io;
219
237 int kernel_cache;
238
245 int auto_cache;
246
252 int ac_attr_timeout_set;
253 double ac_attr_timeout;
254
265 int nullpath_ok;
266
271 int show_help;
272 char *modules;
273 int debug;
274 };
275
276
299 struct fuse_operations {
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
436 int (*open) (const char *, struct fuse_file_info *);
437
447 int (*read) (const char *, char *, size_t, off_t,
448 struct fuse_file_info *);
449
459 int (*write) (const char *, const char *, size_t, off_t,
460 struct fuse_file_info *);
461
466 int (*statfs) (const char *, struct statvfs *);
467
496 int (*flush) (const char *, struct fuse_file_info *);
497
510 int (*release) (const char *, struct fuse_file_info *);
511
517 int (*fsync) (const char *, int, struct fuse_file_info *);
518
520 int (*setxattr) (const char *, const char *, const char *, size_t, int);
521
523 int (*getxattr) (const char *, const char *, char *, size_t);
524
526 int (*listxattr) (const char *, char *, size_t);
527
529 int (*removexattr) (const char *, const char *);
530
539 int (*opendir) (const char *, struct fuse_file_info *);
540
556 int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
557 struct fuse_file_info *, enum fuse_readdir_flags);
558
561 int (*releasedir) (const char *, struct fuse_file_info *);
562
568 int (*fsyncdir) (const char *, int, struct fuse_file_info *);
569
578 void *(*init) (struct fuse_conn_info *conn,
579 struct fuse_config *cfg);
580
586 void (*destroy) (void *private_data);
587
597 int (*access) (const char *, int);
598
609 int (*create) (const char *, mode_t, struct fuse_file_info *);
610
641 int (*lock) (const char *, struct fuse_file_info *, int cmd,
642 struct flock *);
643
656 int (*utimens) (const char *, const struct timespec tv[2],
657 struct fuse_file_info *fi);
658
665 int (*bmap) (const char *, size_t blocksize, uint64_t *idx);
666
683 int (*ioctl) (const char *, unsigned int cmd, void *arg,
684 struct fuse_file_info *, unsigned int flags, void *data);
685
701 int (*poll) (const char *, struct fuse_file_info *,
702 struct fuse_pollhandle *ph, unsigned *reventsp);
703
713 int (*write_buf) (const char *, struct fuse_bufvec *buf, off_t off,
714 struct fuse_file_info *);
715
730 int (*read_buf) (const char *, struct fuse_bufvec **bufp,
731 size_t size, off_t off, struct fuse_file_info *);
750 int (*flock) (const char *, struct fuse_file_info *, int op);
751
760 int (*fallocate) (const char *, int, off_t, off_t,
761 struct fuse_file_info *);
762
774 ssize_t (*copy_file_range) (const char *path_in,
775 struct fuse_file_info *fi_in,
776 off_t offset_in, const char *path_out,
777 struct fuse_file_info *fi_out,
778 off_t offset_out, size_t size, int flags);
779
783 off_t (*lseek) (const char *, off_t off, int whence, struct fuse_file_info *);
784 };
785
791 struct fuse_context {
793 struct fuse *fuse;
794
796 uid_t uid;
797
799 gid_t gid;
800
802 pid_t pid;
803
805 void *private_data;
806
808 mode_t umask;
809 };
810
865 /*
866 int fuse_main(int argc, char *argv[], const struct fuse_operations *op,
867 void *private_data);
868 */
869 #define fuse_main(argc, argv, op, private_data) \
870 fuse_main_real(argc, argv, op, sizeof(*(op)), private_data)
871
872 /* ----------------------------------------------------------- *
873 * More detailed API *
874 * ----------------------------------------------------------- */
875
887 void fuse_lib_help(struct fuse_args *args);
888
916 #if FUSE_USE_VERSION == 30
917 struct fuse *fuse_new_30(struct fuse_args *args, const struct fuse_operations *op,
918 size_t op_size, void *private_data);
919 #define fuse_new(args, op, size, data) fuse_new_30(args, op, size, data)
920 #else
921 struct fuse *fuse_new(struct fuse_args *args, const struct fuse_operations *op,
922 size_t op_size, void *private_data);
923 #endif
924
933 int fuse_mount(struct fuse *f, const char *mountpoint);
934
942 void fuse_unmount(struct fuse *f);
943
952 void fuse_destroy(struct fuse *f);
953
969 int fuse_loop(struct fuse *f);
970
979 void fuse_exit(struct fuse *f);
980
1012 #if FUSE_USE_VERSION < 32
1013 int fuse_loop_mt_31(struct fuse *f, int clone_fd);
1014 #define fuse_loop_mt(f, clone_fd) fuse_loop_mt_31(f, clone_fd)
1015 #else
1016 int fuse_loop_mt(struct fuse *f, struct fuse_loop_config *config);
1017 #endif
1018
1027 struct fuse_context *fuse_get_context(void);
1028
1047 int fuse_getgroups(int size, gid_t list[]);
1048
1054 int fuse_interrupted(void);
1055
1067 int fuse_invalidate_path(struct fuse *f, const char *path);
1068
1074 int fuse_main_real(int argc, char *argv[], const struct fuse_operations *op,
1075 size_t op_size, void *private_data);
1076
1084 int fuse_start_cleanup_thread(struct fuse *fuse);
1085
1092 void fuse_stop_cleanup_thread(struct fuse *fuse);
1093
1103 int fuse_clean_cache(struct fuse *fuse);
1104
1105 /*
1106 * Stacking API
1107 */
1108
1114 struct fuse_fs;
1115
1116 /*
1117 * These functions call the relevant filesystem operation, and return
1118 * the result.
1119 *
1120 * If the operation is not defined, they return -ENOSYS, with the
1121 * exception of fuse_fs_open, fuse_fs_release, fuse_fs_opendir,
1122 * fuse_fs_releasedir and fuse_fs_statfs, which return 0.
1123 */
1124
1125 int fuse_fs_getattr(struct fuse_fs *fs, const char *path, struct stat *buf,
1126 struct fuse_file_info *fi);
1127 int fuse_fs_rename(struct fuse_fs *fs, const char *oldpath,
1128 const char *newpath, unsigned int flags);
1129 int fuse_fs_unlink(struct fuse_fs *fs, const char *path);
1130 int fuse_fs_rmdir(struct fuse_fs *fs, const char *path);
1131 int fuse_fs_symlink(struct fuse_fs *fs, const char *linkname,
1132 const char *path);
1133 int fuse_fs_link(struct fuse_fs *fs, const char *oldpath, const char *newpath);
1134 int fuse_fs_release(struct fuse_fs *fs, const char *path,
1135 struct fuse_file_info *fi);
1136 int fuse_fs_open(struct fuse_fs *fs, const char *path,
1137 struct fuse_file_info *fi);
1138 int fuse_fs_read(struct fuse_fs *fs, const char *path, char *buf, size_t size,
1139 off_t off, struct fuse_file_info *fi);
1140 int fuse_fs_read_buf(struct fuse_fs *fs, const char *path,
1141 struct fuse_bufvec **bufp, size_t size, off_t off,
1142 struct fuse_file_info *fi);
1143 int fuse_fs_write(struct fuse_fs *fs, const char *path, const char *buf,
1144 size_t size, off_t off, struct fuse_file_info *fi);
1145 int fuse_fs_write_buf(struct fuse_fs *fs, const char *path,
1146 struct fuse_bufvec *buf, off_t off,
1147 struct fuse_file_info *fi);
1148 int fuse_fs_fsync(struct fuse_fs *fs, const char *path, int datasync,
1149 struct fuse_file_info *fi);
1150 int fuse_fs_flush(struct fuse_fs *fs, const char *path,
1151 struct fuse_file_info *fi);
1152 int fuse_fs_statfs(struct fuse_fs *fs, const char *path, struct statvfs *buf);
1153 int fuse_fs_opendir(struct fuse_fs *fs, const char *path,
1154 struct fuse_file_info *fi);
1155 int fuse_fs_readdir(struct fuse_fs *fs, const char *path, void *buf,
1156 fuse_fill_dir_t filler, off_t off,
1157 struct fuse_file_info *fi, enum fuse_readdir_flags flags);
1158 int fuse_fs_fsyncdir(struct fuse_fs *fs, const char *path, int datasync,
1159 struct fuse_file_info *fi);
1160 int fuse_fs_releasedir(struct fuse_fs *fs, const char *path,
1161 struct fuse_file_info *fi);
1162 int fuse_fs_create(struct fuse_fs *fs, const char *path, mode_t mode,
1163 struct fuse_file_info *fi);
1164 int fuse_fs_lock(struct fuse_fs *fs, const char *path,
1165 struct fuse_file_info *fi, int cmd, struct flock *lock);
1166 int fuse_fs_flock(struct fuse_fs *fs, const char *path,
1167 struct fuse_file_info *fi, int op);
1168 int fuse_fs_chmod(struct fuse_fs *fs, const char *path, mode_t mode,
1169 struct fuse_file_info *fi);
1170 int fuse_fs_chown(struct fuse_fs *fs, const char *path, uid_t uid, gid_t gid,
1171 struct fuse_file_info *fi);
1172 int fuse_fs_truncate(struct fuse_fs *fs, const char *path, off_t size,
1173 struct fuse_file_info *fi);
1174 int fuse_fs_utimens(struct fuse_fs *fs, const char *path,
1175 const struct timespec tv[2], struct fuse_file_info *fi);
1176 int fuse_fs_access(struct fuse_fs *fs, const char *path, int mask);
1177 int fuse_fs_readlink(struct fuse_fs *fs, const char *path, char *buf,
1178 size_t len);
1179 int fuse_fs_mknod(struct fuse_fs *fs, const char *path, mode_t mode,
1180 dev_t rdev);
1181 int fuse_fs_mkdir(struct fuse_fs *fs, const char *path, mode_t mode);
1182 int fuse_fs_setxattr(struct fuse_fs *fs, const char *path, const char *name,
1183 const char *value, size_t size, int flags);
1184 int fuse_fs_getxattr(struct fuse_fs *fs, const char *path, const char *name,
1185 char *value, size_t size);
1186 int fuse_fs_listxattr(struct fuse_fs *fs, const char *path, char *list,
1187 size_t size);
1188 int fuse_fs_removexattr(struct fuse_fs *fs, const char *path,
1189 const char *name);
1190 int fuse_fs_bmap(struct fuse_fs *fs, const char *path, size_t blocksize,
1191 uint64_t *idx);
1192 int fuse_fs_ioctl(struct fuse_fs *fs, const char *path, unsigned int cmd,
1193 void *arg, struct fuse_file_info *fi, unsigned int flags,
1194 void *data);
1195 int fuse_fs_poll(struct fuse_fs *fs, const char *path,
1196 struct fuse_file_info *fi, struct fuse_pollhandle *ph,
1197 unsigned *reventsp);
1198 int fuse_fs_fallocate(struct fuse_fs *fs, const char *path, int mode,
1199 off_t offset, off_t length, struct fuse_file_info *fi);
1200 ssize_t fuse_fs_copy_file_range(struct fuse_fs *fs, const char *path_in,
1201 struct fuse_file_info *fi_in, off_t off_in,
1202 const char *path_out,
1203 struct fuse_file_info *fi_out, off_t off_out,
1204 size_t len, int flags);
1205 off_t fuse_fs_lseek(struct fuse_fs *fs, const char *path, off_t off, int whence,
1206 struct fuse_file_info *fi);
1207 void fuse_fs_init(struct fuse_fs *fs, struct fuse_conn_info *conn,
1208 struct fuse_config *cfg);
1209 void fuse_fs_destroy(struct fuse_fs *fs);
1210
1211 int fuse_notify_poll(struct fuse_pollhandle *ph);
1212
1226 struct fuse_fs *fuse_fs_new(const struct fuse_operations *op, size_t op_size,
1227 void *private_data);
1228
1243 typedef struct fuse_fs *(*fuse_module_factory_t)(struct fuse_args *args,
1244 struct fuse_fs *fs[]);
1255 #define FUSE_REGISTER_MODULE(name_, factory_) \
1256 fuse_module_factory_t fuse_module_ ## name_ ## _factory = factory_
1257
1259 struct fuse_session *fuse_get_session(struct fuse *f);
1260
1269 int fuse_open_channel(const char *mountpoint, const char *options);
1270
1271 #ifdef __cplusplus
1272 }
1273 #endif
1274
1275 #endif /* FUSE_H_ */
fuse_main_real
int fuse_main_real(int argc, char *argv[], const struct fuse_operations *op, size_t op_size, void *private_data)
Definition: helper.c:279
fuse_bufvec::off
size_t off
Definition: fuse_common.h:721
fuse_invalidate_path
int fuse_invalidate_path(struct fuse *f, const char *path)
Definition: fuse.c:4631
fuse_get_session
struct fuse_session * fuse_get_session(struct fuse *f)
Definition: fuse.c:4504
fuse_conn_info
Definition: fuse_common.h:385
fuse_config::auto_cache
int auto_cache
Definition: fuse.h:245
fuse_fill_dir_flags
fuse_fill_dir_flags
Definition: fuse.h:54
fuse_config::set_gid
int set_gid
Definition: fuse.h:98
fuse_open_channel
int fuse_open_channel(const char *mountpoint, const char *options)
Definition: helper.c:424
fuse_fs_new
struct fuse_fs * fuse_fs_new(const struct fuse_operations *op, size_t op_size, void *private_data)
Definition: fuse.c:4806
fuse_config::readdir_ino
int readdir_ino
Definition: fuse.h:199
fuse_clean_cache
int fuse_clean_cache(struct fuse *fuse)
Definition: fuse.c:4417
fuse_config::intr
int intr
Definition: fuse.h:140
fuse_config::set_mode
int set_mode
Definition: fuse.h:112
fuse_get_context
struct fuse_context * fuse_get_context(void)
Definition: fuse.c:4602
fuse_lib_help
void fuse_lib_help(struct fuse_args *args)
Definition: fuse.c:4696
fuse_loop
int fuse_loop(struct fuse *f)
Definition: fuse.c:4561
fuse_interrupted
int fuse_interrupted(void)
Definition: fuse.c:4621
fuse_context::fuse
struct fuse * fuse
Definition: fuse.h:793
FUSE_READDIR_PLUS
Definition: fuse.h:51
fuse_config::nullpath_ok
int nullpath_ok
Definition: fuse.h:265
fuse_config::negative_timeout
double negative_timeout
Definition: fuse.h:129
fuse_new
struct fuse * fuse_new(struct fuse_args *args, const struct fuse_operations *op, size_t op_size, void *private_data)
fuse_file_info
Definition: fuse_common.h:44
fuse_common.h
FUSE_FILL_DIR_PLUS
Definition: fuse.h:64
fuse_exit
void fuse_exit(struct fuse *f)
Definition: fuse.c:4597
fuse_stop_cleanup_thread
void fuse_stop_cleanup_thread(struct fuse *fuse)
Definition: fuse.c:4862
fuse_config::set_uid
int set_uid
Definition: fuse.h:105
fuse_config::remember
int remember
Definition: fuse.h:159
fuse_config::use_ino
int use_ino
Definition: fuse.h:190
fuse_operations
Definition: fuse.h:299
fuse_file_info::flags
int flags
Definition: fuse_common.h:46
fuse_bufvec
Definition: fuse_common.h:707
fuse_loop_config
Definition: fuse_common.h:107
fuse_unmount
void fuse_unmount(struct fuse *f)
Definition: fuse.c:5108
fuse_getgroups
int fuse_getgroups(int size, gid_t list[])
Definition: fuse.c:4612
fuse_mount
int fuse_mount(struct fuse *f, const char *mountpoint)
Definition: fuse.c:5103
fuse_config::attr_timeout
double attr_timeout
Definition: fuse.h:135
fuse_config::direct_io
int direct_io
Definition: fuse.h:218
fuse_config::show_help
int show_help
Definition: fuse.h:271
fuse_readdir_flags
fuse_readdir_flags
Definition: fuse.h:42
fuse_config
Definition: fuse.h:93
fuse_destroy
void fuse_destroy(struct fuse *f)
Definition: fuse.c:5053
fuse_context
Definition: fuse.h:791
fuse_config::ac_attr_timeout_set
int ac_attr_timeout_set
Definition: fuse.h:252
fuse_fill_dir_t
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
fuse_bufvec::buf
struct fuse_buf buf[1]
Definition: fuse_common.h:726
fuse_args
Definition: fuse_opt.h:109
fuse_config::entry_timeout
double entry_timeout
Definition: fuse.h:119
fuse_context::private_data
void * private_data
Definition: fuse.h:805
fuse_config::kernel_cache
int kernel_cache
Definition: fuse.h:237
fuse_config::intr_signal
int intr_signal
Definition: fuse.h:147
fuse_config::hard_remove
int hard_remove
Definition: fuse.h:177
fuse_start_cleanup_thread
int fuse_start_cleanup_thread(struct fuse *fuse)
Definition: fuse.c:4854
fuse_loop_mt_31
int fuse_loop_mt_31(struct fuse *f, int clone_fd)
Definition: fuse.c:4589