fuse.h

Go to the documentation of this file.

/*
  FUSE: Filesystem in Userspace
  Copyright (C) 2001-2007  Miklos Szeredi <miklos@szeredi.hu>
 
  This program can be distributed under the terms of the GNU LGPLv2.
  See the file LGPL2.txt.
*/
 
#ifndef FUSE_H_
#define FUSE_H_

 
#include "fuse_common.h"
 
#include <fcntl.h>
#include <time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/statvfs.h>
#include <sys/uio.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ----------------------------------------------------------- *
 * Basic FUSE API                                              *
 * ----------------------------------------------------------- */
 
/* Forward declaration */
struct statx;

struct fuse;

enum fuse_readdir_flags {
        FUSE_READDIR_DEFAULTS = 0,
        FUSE_READDIR_PLUS = (1 << 0)
};

enum fuse_fill_dir_flags {
        FUSE_FILL_DIR_DEFAULTS = 0,
        FUSE_FILL_DIR_PLUS = (1 << 1)
};

typedef int (*fuse_fill_dir_t) (void *buf, const char *name,
                                const struct stat *stbuf, off_t off,
                                enum fuse_fill_dir_flags flags);
struct fuse_config {
        int32_t set_gid;
        uint32_t gid;

        int32_t set_uid;
        uint32_t uid;

        int32_t set_mode;
        uint32_t umask;

        double entry_timeout;

        double negative_timeout;

        double attr_timeout;

        int32_t intr;

        int32_t intr_signal;

        int32_t remember;

        int32_t hard_remove;

        int32_t use_ino;

        int32_t readdir_ino;

        int32_t direct_io;

        int32_t kernel_cache;

        int32_t auto_cache;
 
        /*
         * The timeout in seconds for which file attributes are cached
         * for the purpose of checking if auto_cache should flush the
         * file data on open.
         */
        int32_t ac_attr_timeout_set;
        double ac_attr_timeout;

        int32_t nullpath_ok;

        int32_t show_help;
        char *modules;
        int32_t debug;

        uint32_t fmask;
        uint32_t dmask;

        int32_t no_rofd_flush;

        int32_t parallel_direct_writes;
 

        uint32_t flags;

        uint64_t reserved[48];
};
 

struct fuse_operations {
        int (*getattr) (const char *, struct stat *, struct fuse_file_info *fi);

        int (*readlink) (const char *, char *, size_t);

        int (*mknod) (const char *, mode_t, dev_t);

        int (*mkdir) (const char *, mode_t);

        int (*unlink) (const char *);

        int (*rmdir) (const char *);

        int (*symlink) (const char *, const char *);

        int (*rename) (const char *, const char *, unsigned int flags);

        int (*link) (const char *, const char *);

        int (*chmod) (const char *, mode_t, struct fuse_file_info *fi);

        int (*chown) (const char *, uid_t, gid_t, struct fuse_file_info *fi);

        int (*truncate) (const char *, off_t, struct fuse_file_info *fi);

        int (*open) (const char *, struct fuse_file_info *);

        int (*read) (const char *, char *, size_t, off_t,
                     struct fuse_file_info *);

        int (*write) (const char *, const char *, size_t, off_t,
                      struct fuse_file_info *);

        int (*statfs) (const char *, struct statvfs *);

        int (*flush) (const char *, struct fuse_file_info *);

        int (*release) (const char *, struct fuse_file_info *);

        int (*fsync) (const char *, int, struct fuse_file_info *);

        int (*setxattr) (const char *, const char *, const char *, size_t, int);

        int (*getxattr) (const char *, const char *, char *, size_t);

        int (*listxattr) (const char *, char *, size_t);

        int (*removexattr) (const char *, const char *);

        int (*opendir) (const char *, struct fuse_file_info *);

        int (*readdir) (const char *, void *, fuse_fill_dir_t, off_t,
                        struct fuse_file_info *, enum fuse_readdir_flags);

        int (*releasedir) (const char *, struct fuse_file_info *);

        int (*fsyncdir) (const char *, int, struct fuse_file_info *);

        void *(*init) (struct fuse_conn_info *conn,
                       struct fuse_config *cfg);

        void (*destroy) (void *private_data);

        int (*access) (const char *, int);

        int (*create) (const char *, mode_t, struct fuse_file_info *);

        int (*lock) (const char *, struct fuse_file_info *, int cmd,
                     struct flock *);

         int (*utimens) (const char *, const struct timespec tv[2],
                         struct fuse_file_info *fi);

        int (*bmap) (const char *, size_t blocksize, uint64_t *idx);
 
#if FUSE_USE_VERSION < 35
        int (*ioctl) (const char *, int cmd, void *arg,
                      struct fuse_file_info *, unsigned int flags, void *data);
#else
        int (*ioctl) (const char *, unsigned int cmd, void *arg,
                      struct fuse_file_info *, unsigned int flags, void *data);
#endif

        int (*poll) (const char *, struct fuse_file_info *,
                     struct fuse_pollhandle *ph, unsigned *reventsp);

        int (*write_buf) (const char *, struct fuse_bufvec *buf, off_t off,
                          struct fuse_file_info *);

        int (*read_buf) (const char *, struct fuse_bufvec **bufp,
                         size_t size, off_t off, struct fuse_file_info *);
        int (*flock) (const char *, struct fuse_file_info *, int op);

        int (*fallocate) (const char *, int, off_t, off_t,
                          struct fuse_file_info *);

        ssize_t (*copy_file_range) (const char *path_in,
                                    struct fuse_file_info *fi_in,
                                    off_t offset_in, const char *path_out,
                                    struct fuse_file_info *fi_out,
                                    off_t offset_out, size_t size, int flags);

        off_t (*lseek) (const char *, off_t off, int whence, struct fuse_file_info *);

        int (*statx)(const char *path, int flags, int mask, struct statx *stxbuf,
                     struct fuse_file_info *fi);
};

struct fuse_context {
        struct fuse *fuse;

        uid_t uid;

        gid_t gid;

        pid_t pid;

        void *private_data;

        mode_t umask;
};

int fuse_main_real_versioned(int argc, char *argv[],
                             const struct fuse_operations *op, size_t op_size,
                             struct libfuse_version *version, void *user_data);
static inline int fuse_main_real(int argc, char *argv[],
                                 const struct fuse_operations *op,
                                 size_t op_size, void *user_data)
{
        struct libfuse_version version = { .major = FUSE_MAJOR_VERSION,
                                           .minor = FUSE_MINOR_VERSION,
                                           .hotfix = FUSE_HOTFIX_VERSION,
                                           .padding = 0 };
 
        fuse_log(FUSE_LOG_ERR,
                 "%s is a libfuse internal function, please use fuse_main()\n",
                 __func__);
 
        return fuse_main_real_versioned(argc, argv, op, op_size, &version,
                                        user_data);
}

static inline int fuse_main_fn(int argc, char *argv[],
                               const struct fuse_operations *op,
                               void *user_data)
{
        struct libfuse_version version = {
                .major  = FUSE_MAJOR_VERSION,
                .minor  = FUSE_MINOR_VERSION,
                .hotfix = FUSE_HOTFIX_VERSION,
                .padding = 0
        };
 
        return fuse_main_real_versioned(argc, argv, op, sizeof(*(op)), &version,
                                        user_data);
}
#define fuse_main(argc, argv, op, user_data) \
        fuse_main_fn(argc, argv, op, user_data)
 
/* ----------------------------------------------------------- *
 * More detailed API                                           *
 * ----------------------------------------------------------- */

void fuse_lib_help(struct fuse_args *args);
 
/* Do not call this directly, use fuse_new() instead */
struct fuse *_fuse_new_30(struct fuse_args *args,
                          const struct fuse_operations *op, size_t op_size,
                          struct libfuse_version *version, void *user_data);
struct fuse *_fuse_new_31(struct fuse_args *args,
                          const struct fuse_operations *op, size_t op_size,
                          struct libfuse_version *version, void *user_data);

#if FUSE_USE_VERSION == 30
static inline struct fuse *fuse_new_fn(struct fuse_args *args,
                                       const struct fuse_operations *op,
                                       size_t op_size, void *user_data)
{
        struct libfuse_version version = {
                .major = FUSE_MAJOR_VERSION,
                .minor = FUSE_MINOR_VERSION,
                .hotfix = FUSE_HOTFIX_VERSION,
                .padding = 0
        };
 
        return _fuse_new_30(args, op, op_size, &version, user_data);
}
#else /* FUSE_USE_VERSION */
static inline struct fuse *fuse_new_fn(struct fuse_args *args,
                                       const struct fuse_operations *op,
                                       size_t op_size, void *user_data)
{
        struct libfuse_version version = {
                .major = FUSE_MAJOR_VERSION,
                .minor = FUSE_MINOR_VERSION,
                .hotfix = FUSE_HOTFIX_VERSION,
                .padding = 0
        };
 
        return _fuse_new_31(args, op, op_size, &version, user_data);
}
#endif
#define fuse_new(args, op, size, data) fuse_new_fn(args, op, size, data)

int fuse_mount(struct fuse *f, const char *mountpoint);

void fuse_unmount(struct fuse *f);

void fuse_destroy(struct fuse *f);

int fuse_loop(struct fuse *f);

void fuse_exit(struct fuse *f);
 
#if FUSE_USE_VERSION < 32
int fuse_loop_mt_31(struct fuse *f, int clone_fd);
#define fuse_loop_mt(f, clone_fd) fuse_loop_mt_31(f, clone_fd)
#elif FUSE_USE_VERSION < FUSE_MAKE_VERSION(3, 12)
int fuse_loop_mt_32(struct fuse *f, struct fuse_loop_config *config);
#define fuse_loop_mt(f, config) fuse_loop_mt_32(f, config)
#else
#if (defined(LIBFUSE_BUILT_WITH_VERSIONED_SYMBOLS))
int fuse_loop_mt(struct fuse *f, struct fuse_loop_config *config);
#else
int fuse_loop_mt_312(struct fuse *f, struct fuse_loop_config *config);
#define fuse_loop_mt(f, config) fuse_loop_mt_312(f, config)
#endif /* LIBFUSE_BUILT_WITH_VERSIONED_SYMBOLS */
#endif
 

struct fuse_context *fuse_get_context(void);

int fuse_getgroups(int size, gid_t list[]);

int fuse_interrupted(void);

int fuse_invalidate_path(struct fuse *f, const char *path);

int fuse_start_cleanup_thread(struct fuse *fuse);

void fuse_stop_cleanup_thread(struct fuse *fuse);

int fuse_clean_cache(struct fuse *fuse);
 
/*
 * Stacking API
 */

struct fuse_fs;
 
/*
 * These functions call the relevant filesystem operation, and return
 * the result.
 *
 * If the operation is not defined, they return -ENOSYS, with the
 * exception of fuse_fs_open, fuse_fs_release, fuse_fs_opendir,
 * fuse_fs_releasedir and fuse_fs_statfs, which return 0.
 */
 
int fuse_fs_getattr(struct fuse_fs *fs, const char *path, struct stat *buf,
                    struct fuse_file_info *fi);
int fuse_fs_rename(struct fuse_fs *fs, const char *oldpath,
                   const char *newpath, unsigned int flags);
int fuse_fs_unlink(struct fuse_fs *fs, const char *path);
int fuse_fs_rmdir(struct fuse_fs *fs, const char *path);
int fuse_fs_symlink(struct fuse_fs *fs, const char *linkname,
                    const char *path);
int fuse_fs_link(struct fuse_fs *fs, const char *oldpath, const char *newpath);
int fuse_fs_release(struct fuse_fs *fs,  const char *path,
                    struct fuse_file_info *fi);
int fuse_fs_open(struct fuse_fs *fs, const char *path,
                 struct fuse_file_info *fi);
int fuse_fs_read(struct fuse_fs *fs, const char *path, char *buf, size_t size,
                 off_t off, struct fuse_file_info *fi);
int fuse_fs_read_buf(struct fuse_fs *fs, const char *path,
                     struct fuse_bufvec **bufp, size_t size, off_t off,
                     struct fuse_file_info *fi);
int fuse_fs_write(struct fuse_fs *fs, const char *path, const char *buf,
                  size_t size, off_t off, struct fuse_file_info *fi);
int fuse_fs_write_buf(struct fuse_fs *fs, const char *path,
                      struct fuse_bufvec *buf, off_t off,
                      struct fuse_file_info *fi);
int fuse_fs_fsync(struct fuse_fs *fs, const char *path, int datasync,
                  struct fuse_file_info *fi);
int fuse_fs_flush(struct fuse_fs *fs, const char *path,
                  struct fuse_file_info *fi);
int fuse_fs_statfs(struct fuse_fs *fs, const char *path, struct statvfs *buf);
int fuse_fs_opendir(struct fuse_fs *fs, const char *path,
                    struct fuse_file_info *fi);
int fuse_fs_readdir(struct fuse_fs *fs, const char *path, void *buf,
                    fuse_fill_dir_t filler, off_t off,
                    struct fuse_file_info *fi, enum fuse_readdir_flags flags);
int fuse_fs_fsyncdir(struct fuse_fs *fs, const char *path, int datasync,
                     struct fuse_file_info *fi);
int fuse_fs_releasedir(struct fuse_fs *fs, const char *path,
                       struct fuse_file_info *fi);
int fuse_fs_create(struct fuse_fs *fs, const char *path, mode_t mode,
                   struct fuse_file_info *fi);
int fuse_fs_lock(struct fuse_fs *fs, const char *path,
                 struct fuse_file_info *fi, int cmd, struct flock *lock);
int fuse_fs_flock(struct fuse_fs *fs, const char *path,
                  struct fuse_file_info *fi, int op);
int fuse_fs_chmod(struct fuse_fs *fs, const char *path, mode_t mode,
                  struct fuse_file_info *fi);
int fuse_fs_chown(struct fuse_fs *fs, const char *path, uid_t uid, gid_t gid,
                  struct fuse_file_info *fi);
int fuse_fs_truncate(struct fuse_fs *fs, const char *path, off_t size,
                     struct fuse_file_info *fi);
int fuse_fs_utimens(struct fuse_fs *fs, const char *path,
                    const struct timespec tv[2], struct fuse_file_info *fi);
int fuse_fs_access(struct fuse_fs *fs, const char *path, int mask);
int fuse_fs_readlink(struct fuse_fs *fs, const char *path, char *buf,
                     size_t len);
int fuse_fs_mknod(struct fuse_fs *fs, const char *path, mode_t mode,
                  dev_t rdev);
int fuse_fs_mkdir(struct fuse_fs *fs, const char *path, mode_t mode);
int fuse_fs_setxattr(struct fuse_fs *fs, const char *path, const char *name,
                     const char *value, size_t size, int flags);
int fuse_fs_getxattr(struct fuse_fs *fs, const char *path, const char *name,
                     char *value, size_t size);
int fuse_fs_listxattr(struct fuse_fs *fs, const char *path, char *list,
                      size_t size);
int fuse_fs_removexattr(struct fuse_fs *fs, const char *path,
                        const char *name);
int fuse_fs_bmap(struct fuse_fs *fs, const char *path, size_t blocksize,
                 uint64_t *idx);
#if FUSE_USE_VERSION < 35
int fuse_fs_ioctl(struct fuse_fs *fs, const char *path, int cmd,
                  void *arg, struct fuse_file_info *fi, unsigned int flags,
                  void *data);
#else
int fuse_fs_ioctl(struct fuse_fs *fs, const char *path, unsigned int cmd,
                  void *arg, struct fuse_file_info *fi, unsigned int flags,
                  void *data);
#endif
int fuse_fs_poll(struct fuse_fs *fs, const char *path,
                 struct fuse_file_info *fi, struct fuse_pollhandle *ph,
                 unsigned *reventsp);
int fuse_fs_fallocate(struct fuse_fs *fs, const char *path, int mode,
                 off_t offset, off_t length, struct fuse_file_info *fi);
ssize_t fuse_fs_copy_file_range(struct fuse_fs *fs, const char *path_in,
                                struct fuse_file_info *fi_in, off_t off_in,
                                const char *path_out,
                                struct fuse_file_info *fi_out, off_t off_out,
                                size_t len, int flags);
off_t fuse_fs_lseek(struct fuse_fs *fs, const char *path, off_t off, int whence,
                    struct fuse_file_info *fi);
int fuse_fs_statx(struct fuse_fs *fs, const char *path, int flags, int mask,
                  struct statx *stxbuf, struct fuse_file_info *fi);
void fuse_fs_init(struct fuse_fs *fs, struct fuse_conn_info *conn,
                struct fuse_config *cfg);
void fuse_fs_destroy(struct fuse_fs *fs);
 
int fuse_notify_poll(struct fuse_pollhandle *ph);

struct fuse_fs *fuse_fs_new(const struct fuse_operations *op, size_t op_size,
                            void *private_data);

typedef struct fuse_fs *(*fuse_module_factory_t)(struct fuse_args *args,
                                                 struct fuse_fs *fs[]);
#define FUSE_REGISTER_MODULE(name_, factory_) \
        fuse_module_factory_t fuse_module_ ## name_ ## _factory = factory_

struct fuse_session *fuse_get_session(struct fuse *f);

int fuse_open_channel(const char *mountpoint, const char *options);
 
#ifdef __cplusplus
}
#endif
 
#endif /* FUSE_H_ */