xref: /netbsd-src/lib/librefuse/refuse/v30.h (revision ec9afb42821c4c1dc720bf626e8bbd4d8ab9d6b4)
1 /* $NetBSD: v30.h,v 1.1 2022/01/22 08:09:40 pho Exp $ */
2 
3 /*
4  * Copyright (c) 2021 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote
16  *    products derived from this software without specific prior written
17  *    permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
20  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
25  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 #if !defined(_FUSE_V30_H_)
32 #define _FUSE_V30_H_
33 
34 /* Compatibility header with FUSE 3.0 API. Only declarations that have
35  * differences between versions should be listed here. */
36 
37 #if !defined(FUSE_H_)
38 #  error Do not include this header directly. Include <fuse.h> instead.
39 #endif
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /* Defined in <fuse_lowlevel.h> */
46 struct fuse_cmdline_opts;
47 
48 /* Function to add an entry in a readdir() operation. Introduced on
49  * FUSE 2.3 and changed on FUSE 3.0. */
50 typedef int (*fuse_fill_dir_t_v30)(
51 	void *, const char *, const struct stat *, off_t, enum fuse_fill_dir_flags flags);
52 
53 /* The table of file system operations in FUSE 3.0. */
54 struct fuse_operations_v30 {
55 	int	(*getattr)		(const char *, struct stat *, struct fuse_file_info *fi);
56 	int	(*readlink)		(const char *, char *, size_t);
57 	/* getdir has been removed as of FUSE 3.0. */
58 	int	(*mknod)		(const char *, mode_t, dev_t);
59 	int	(*mkdir)		(const char *, mode_t);
60 	int	(*unlink)		(const char *);
61 	int	(*rmdir)		(const char *);
62 	int	(*symlink)		(const char *, const char *);
63 	int	(*rename)		(const char *, const char *, unsigned int);
64 	int	(*link)			(const char *, const char *);
65 	int	(*chmod)		(const char *, mode_t, struct fuse_file_info *fi);
66 	int	(*chown)		(const char *, uid_t, gid_t, struct fuse_file_info *fi);
67 	int	(*truncate)		(const char *, off_t, struct fuse_file_info *fi);
68 	/* utime has been removed as of FUSE 3.0. */
69 	int	(*open)			(const char *, struct fuse_file_info *);
70 	int	(*read)			(const char *, char *, size_t, off_t, struct fuse_file_info *);
71 	int	(*write)		(const char *, const char *, size_t, off_t, struct fuse_file_info *);
72 	int	(*statfs)		(const char *, struct statvfs *);
73 	int	(*flush)		(const char *, struct fuse_file_info *);
74 	int	(*release)		(const char *, struct fuse_file_info *);
75 	int	(*fsync)		(const char *, int, struct fuse_file_info *);
76 	int	(*setxattr)		(const char *, const char *, const char *, size_t, int);
77 	int	(*getxattr)		(const char *, const char *, char *, size_t);
78 	int	(*listxattr)	(const char *, char *, size_t);
79 	int	(*removexattr)	(const char *, const char *);
80 	int	(*opendir)		(const char *, struct fuse_file_info *);
81 	int	(*readdir)		(const char *, void *, fuse_fill_dir_t_v30, off_t, struct fuse_file_info *, enum fuse_readdir_flags);
82 	int	(*releasedir)	(const char *, struct fuse_file_info *);
83 	int	(*fsyncdir)		(const char *, int, struct fuse_file_info *);
84 	void	*(*init)	(struct fuse_conn_info *, struct fuse_config *);
85 	void	(*destroy)	(void *);
86 	int	(*access)		(const char *, int);
87 	int	(*create)		(const char *, mode_t, struct fuse_file_info *);
88 	/* ftruncate has been removed as of FUSE 3.0. */
89 	/* fgetattr has been removed as of FUSE 3.0. */
90 	int	(*lock)			(const char *, struct fuse_file_info *, int, struct flock *);
91 	int	(*utimens)		(const char *, const struct timespec[2], struct fuse_file_info *);
92 	int	(*bmap)			(const char *, size_t , uint64_t *);
93 	/* flag_* have been removed as of FUSE 3.0. */
94 	int	(*ioctl)		(const char *, int, void *, struct fuse_file_info *, unsigned int, void *);
95 	int	(*poll)			(const char *, struct fuse_file_info *, struct fuse_pollhandle *, unsigned *);
96 	int	(*write_buf)	(const char *, struct fuse_bufvec *, off_t, struct fuse_file_info *);
97 	int	(*read_buf)		(const char *, struct fuse_bufvec **, size_t, off_t, struct fuse_file_info *);
98 	int	(*flock)		(const char *, struct fuse_file_info *, int);
99 	int	(*fallocate)	(const char *, int, off_t, off_t, struct fuse_file_info *);
100 };
101 
102 /* Mount a FUSE 3.0 filesystem. */
103 int fuse_mount_v30(struct fuse *fuse, const char *mountpoint);
104 
105 /* Unmount a FUSE 3.0 filesystem. */
106 void fuse_unmount_v30(struct fuse *);
107 
108 /* Create a FUSE 3.0 filesystem. */
109 struct fuse *fuse_new_v30(struct fuse_args *args,
110 						  const void *op, int op_version, void *user_data);
111 
112 /* Destroy a FUSE 3.0 filesystem. */
113 void fuse_destroy_v30(struct fuse *fuse);
114 
115 /* Multithreaded event loop for FUSE >= 3.0 < 3.2. Of course, every
116  * time they change a function prototype to take a single extra
117  * option, they change it again so it takes a struct instead. Every
118  * single time. */
119 int fuse_loop_mt_v30(struct fuse *fuse, int clone_fd);
120 
121 /* Parse common options for FUSE 3.0 */
122 int fuse_parse_cmdline_v30(struct fuse_args *args,
123 						   struct fuse_cmdline_opts *opts);
124 
125 #ifdef __cplusplus
126 }
127 #endif
128 
129 #endif
130